Skip to content

Localization

LenweSaralonde edited this page Sep 1, 2022 · 19 revisions

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

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

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:

  • 🇪🇸 Spanish
  • 🇮🇹 Italian
  • 🇰🇷 Korean
  • 🇵🇹 Portuguese
  • 🇷🇺 Russian (already partially reworked by ToxaAveNCR and Hubbotu)
  • 🇹🇼 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 then open a pull request with your changes. Learn more...

Alternately, if you're not comfortable with using git and GitHub, you can just modify the .lua files corresponding to your language in the latest release of Musician, then post the modified files on the #development-and-localization Discord channel.

Get in touch with the team on Discord to notify that you want to start working on localization (to avoid others to do the same job twice) or if you just need help.

How to edit the locale files

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 committing. Make sure all the texts fit properly in the the UI, frames, buttons etc.

Clone this wiki locally