Localization

Musician and its plugins MusicianList and MusicianMIDI are available in the following languages:

• 🇺🇸 English
• 🇫🇷 French
• 🇨🇳 Simplified Chinese (by Grayson Blackclaw)

The add-ons also have been translated in other languages supported by WoW but using Google Translate. The resulting translations may be erratic so they need to be verified and corrected by real humans.

The translations that need to be reworked are:

• 🇩🇪 German
• 🇪🇸 Spanish
• 🇮🇹 Italian
• 🇰🇷 Korean
• 🇵🇹 Portugese
• 🇷🇺 Russian
• 🇹🇼 Traditional Chinese

If you want to contribute to the project and translate Musician and its Optional modules in your language, you can do so by forking the project on GitHub or using the localization tab on CurseForge.

The GitHub method is preferred because you can test the result by yourself in-game and is much more faster than Curseforge which is very limited and may be a hassle to deal with a large amount of strings. In addition, changes made to the GitHub repo have priority over CurseForge so if several translators make modifications in the GitHub repo while others do so on CurseForge for the same language, the work done on CurseForge can be lost.

Get in touch with the dev team on Discord so we can find out what is the best solution for you.

Contribute using GitHub (recommended)

The GitHub localization workflow is the same as for any git project: clone the project in your own GitHub account, make your changes then create a pull request.

The translation files are located under the add-on locale folder. These are .lua files named after the add-on and locale code. For example, Musician's spanish locale file is Musician.es.lua.

Translation strings always begin with msg. as follows:

msg.SOME_NAME = "Some text"

or

msg.SOME_LIST_NAME["some-list-key"] = "Some value"

• Only the text after the = sign should be modified.
• Untranslated strings are in English and are commented out by a double dash --. Remove the -- when you're done.
• The text is always within double quotes " (ie "text"). If you need to put double quotes inside your string, you should escape them with a backslash (\), as follows "Get the \"Musician\" add-on to become a bard!"
• Text between curly braces { and } are placeholders and should not be translated.
• Always keep your text as a single line. You can use the \n character for carriage returns.
• You can add a comment after your string using a double dash --
• Comments on a single line that start with -- or --- are sections. Don't edit them.

Always test your changes in-game before commiting. Make sure all the texts fit properly in the the UI, frames, buttons etc.

Contribute using CurseForge

You need a CurseForge account to be able to edit the add-ons' localization. Just head to the add-on's Localization tab and make the modifications you like:

• Musician
• MusicianList
• MusicianMIDI

Don't translate the text between curly braces { and }. These are placeholders and should not be translated.

Please always notify the dev team on Discord after you made changes on CurseForge so they can be included in the add-on and you can be credited for your work. This also prevents your work from being lost accidentally.