Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (53 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 3.96 KB
Raw

Contributing to BigNoteBox

Thank you for helping! This page explains how to send a translation. Other kinds of changes are welcome too, but please open an issue first so we can agree on the idea before you write code.

Translating

All text the player sees lives in BigNoteBox/Locales/, one file per language. The file name is the locale code that WoW's GetLocale() returns for that game client, so the name must match exactly, capital letters included.

enUS.lua is English and the reference for every key. Please do not change it.

Translation status

Updated 2026-10-11. English has 2588 keys.

Language File Status
English enUS.lua Reference, always complete
Simplified Chinese zhCN.lua 100% (2588 / 2588), quality check in progress
Traditional Chinese zhTW.lua Not started
Korean koKR.lua Not started
German deDE.lua Not started
French frFR.lua Not started
Spanish (Spain) esES.lua Not started
Spanish (Latin America) esMX.lua Not started
Portuguese (Brazil) ptBR.lua Not started
Italian itIT.lua Not started
Russian ruRU.lua Not started

Notes on the codes:

  • English (UK) clients report enUS, so there is no enGB.lua.
  • Portuguese (Portugal) clients report ptBR, so ptBR.lua covers both.
  • esES and esMX are separate clients. Each needs its own file.

If you start a language, claim it with a Translation issue, so two people do not translate the same file.

Each line is one key and its text:

L["SAVE"] = "保存"

Only change the text on the right side. The key on the left ("SAVE") must stay exactly as it is in enUS.lua.

Rules

  • Keep placeholders. %s, %d and %% are filled in by the addon. Every one in the English text must also be in your translation, in the same order.
  • Keep colour codes and line breaks. Leave |cffRRGGBB, |r and \n where they are. You can move them to fit your sentence, but do not delete them.
  • Missing keys are fine. Any key you do not translate shows in English, so a partial translation does not break anything.
  • Save as UTF-8 without BOM.

Adding a new language

Copy enUS.lua to a new file named after the WoW locale code (zhTW.lua, koKR.lua, deDE.lua and so on). enUS.lua always has every key, so you start from the complete list.

The top of enUS.lua sets up the locale system, and that part must not be copied. In your new file, delete everything above the first L["..."] line and put this there instead, with your own locale code:

-- BigNoteBox Localization -- Traditional Chinese (zhTW)

if GetLocale() ~= "zhTW" then return end

local L = BigNoteBox.L

Then translate. Say in your pull request that it is a new file, and Dukul will add it to the TOC files.

Checking your work in game

Type /reload after changing the file. To see which text still is not translated, open the settings (/bnb), go to the Advanced tab, tick Activate Debug mode under Developer, then tick Debug pseudo-locale and /reload. Every string that goes through the locale file then starts with @@. Text without @@ is hard-coded in the addon. Please report it so it can be moved to the locale file.

Sending your changes

  1. Fork this repository (the Fork button at the top right of the GitHub page).
  2. Edit the locale file in your fork. You can do it directly on GitHub: open the file and click the pencil icon.
  3. Open a pull request to main here. One language per pull request, please.

Dukul reviews every pull request before it is merged. Translations ship with the next release.

License

BigNoteBox's code is licensed under the GNU General Public License version 3 (LICENSE). By sending a pull request you agree that your contribution is released under the same license. The logo and icon are not covered by it: see LICENSE-ASSETS.