Skip to content

Translating

Craig McLure edited this page Mar 8, 2024 · 5 revisions

Translating the GoXLR Utility UI is a relatively straight forward process, but will depend on your general experience. The GoXLR Utility's discord server has a #translators channel for any support or questions you may have.

If you're going to attempt a translation without an IDE, I'd recommend something like Notepad++ which can syntax highlight.

Notes about Translating

Once you have the base file, please note the following:

  • Do NOT translate anything inside curly brackets (for example {channel}), these are special keys and should be left.
  • Try to name files relative to the 'Locale', (so British is en_GB, Italian is it_IT, etc.) Let us know if you need help here :)
  • References can be made internally to already defined strings using their 'path' by using an @: prefix

General Translations

If you just want to provide a translation and aren't familiar with Git, your best bet is to grab the raw base file from here, translate the strings and pass the file over via either discord or a new issue.

I can take care of bringing the translation into the UI, as well as help resolve any questions / comments which may arise.

Developing with Git

This is probably the easier option. Fork the repository, copy src/lang/en_GB.js to a new file and get translating. Once you're done, add the language into src/lang/config.js, and submit a Pull Request.

If during development you would like to test, run npm run dev, and select your language from the dropdown in the very bottom left of the page.

Clone this wiki locally