Terasology/docs/Translation-Guide.md
Tobias Nett 2d8ef61e80
doc: move wiki content to docsify page (#5155)
* rename docs to docs-pre-merge
* add wiki content based on commit e4d4b10424f24eed6583ea0e998da8aa32a27a3f
* replace wikilinks with markdown links in _sidebar
* use sidebar link text as title via ` autoHeader: true` 
* rename files with `:` or `,` in the name
* use the wiki Home page as entry point instead of the repo README
2023-10-31 14:46:35 +01:00

2 KiB

Adding new languages to the game or helping out with translating single strings is easy and helpful as it allows players from all over the world to enjoy the game, unhindered by language barriers!

First off, to keep things nice and clean, we advise you to work on the translation using a feature branch:

  • git checkout develop
  • git branch i18n/{{your-language}}
  • git checkout i18n/{{your-language}}

To create a new language file, copy menu_en.lang to a new file called menu_xx.lang in engine/src/main/resources/assets/i18n - xx should be an ISO 639-1 two-letter code for your language. Next up, translate everything in menu_xx.lang to your target language! Every now and then, check up on your in-progress translation - the game's language can be changed in the Settings - Player menu. Some possible issues that may occur are long strings breaking UI elements and special characters not being rendered properly.

When your translation is finished, add a tiny flag to represent the language in the settings! To do this, download an appropriate 16x11 icon from the famfamfam.com icon pack (or create your own 16x11 icon) and place it inside engine/src/main/resources/assets/textures/ui/icons. Rename it to flag_xx.png, xx being the two-letter code you've used before.

Submit your translation as a pull request. See Contributor Quick Start and Dealing with Forks for help.

And while you're at it, feel free to add yourself to Credits.md as a new contributor!