Translation

This page explains how to translate the Minetest engine, along with mods.

Translating the engine

Translations of the Minetest engine are automated using Weblate. Register an account, select the Minetest project and start translating. Translation is a continuous effort and the texts will change almost at every version.

The developers usually will update the translation templates shortly before a new release. If you translate a long time before a release, your translation updates will still be included, but your translation will likely be incomplete because almost every new version comes with new things to translate. Check out the News forum to see if a new release is imminent.

In case you wish to translate a new language, send a message in #minetest-dev and a coredev can add it.

Language-specific notes

Here is a list of wiki pages for translating specific languages:

• German

Special strings

In the translations you will find one string with a special meaning. It must not be translated literally. They are used internally by Minetest to trigger certain settings. You must enter a special value into the translation field.

• LANG_CODE: The language code of the language you're translating (e.g. "de" for German).

Builtin

Builtin is another core part of Minetest which includes texts for server commands, privilege descriptions, and many other server-related messages. Builtin is translated with a different method, you can't use Weblate here. Builtin is translated like mods (read the section below to learn how) and the translation files work the same like for the mod translation files. You can find the builtin translation files in the Minetest source directory under builtin/locale.

For example, if you want to translate Builtin into German, you need to edit builtin/locale/__builtin.de.tr.

Translating mods and games

Mods and games are translated with special ".tr" files. This includes Minetest Game. This is a different system than the engine translation system.

For translators

To translate a mod, you first need to know if it can even be translated. Check if the following is true:

• The directory locale exists and
• The file template.txt exists in the locale directory.

If both conditions are true, the mod is ready for translation. Otherwise, it is not. In that case, ask the project maintainers to add translation support and the template.txt file.

To translate a mod (or update an existing translation), follow these steps:

1. Check if a file named [MODNAME].[LANG_CODE].tr exists in locale/. If yes, skip to step 3. Otherwise, go to step 2.
2. Copy the provided template.txt to a file named [MODNAME].[LANG_CODE].tr
3. Open the .tr file in a text editor
4. You will encounter a list of texts that end in equals signs. Put the translation of each text after the equals sign (note the special rules below)
5. Save the file

(Note: [MODNAME] is the name of the mod and [LANG_CODE] is the language code)

Done. Now you probably want to test this translation in-game and submit your changes to the mod/game maintainers.

To translate an entire game, you translate all the mods within that game.

Special text rules

Here are the detailed rules of how the ".tr" file is structured.

• The lines that matter for you are all non-empty lines that do not start with "#". These are the translation lines. On the left side of the equals sign, the original text is written. On the right side of the equals sign, the translation has to be written. If the translation is empty, Minetest will display the original text instead.
• Do not change lines that start with "# textdomain:". These are need for technical reasons.
• You can add as many empty lines you want. They will be ignored
• Other lines that start with "#" are comments. Minetest will ignore them but they might contain some information for you. It is up to you whether you keep or remove these lines.

In the texts (both original and translated texts), some characters will be replaced in the actual game:

• "@1", "@2", ... to "@9" are placeholders. The game will replace it with another text. You MUST include all placeholders in the translation, but the order can be different.
• To produce the "@" character, you MUST write "@@"
• To produce the "=" character, you MUST write "@="
• To produce a newline, you MUST write "@n". Alternatively, you can also write "@" followed by an actual newline

Example

Consider the example mod example. You will find the file template.txt with this content:

# textdomain:example
Apple=
Pickaxe=
#This is a comment, not a translation. You can ignore this line.
Welcome, @1!=
@1 has killed @2 and gained @3 EXP.=
E-mail: <somebody@@example.org>=
“@=” is the equals sign=
This text@nhas 2 lines.=Dieser Text@nhat 2 Zeilen.

A possible translation in German would be stored under example.de.tr with this content:

# textdomain:example
Apple=Apfel
Pickaxe=Spitzhacke
#This is a comment, not a translation. You can ignore this line.
Welcome, @1!=Willkommen, @1!
@1 has killed @2 and gained @3 EXP.=@1 hat @2 getötet und @3 EXP erhalten.
E-mail: <somebody@@example.org>=E-Mail: <somebody@@example.org>
“@=” is the equals sign.=»@=« ist das Gleichheitszeichen.
This text@nhas 2 lines.=Dieser Text@nhat 2 Zeilen.

For reference, this is how the English texts could actually show up in Minetest (with the placeholders resolved):

• Apple
• Pickaxe
• Welcome, Merlin!
• Gnerf has killed Hormel and gained 500 EXP.
• E-mail: <somebody@example.org>
• “=” is the equals sign
• This text
  

has 2 lines

For developers

As a mod or game developer, if you want to implement translation support, please refer to the official Lua API documentation (lua_api.md) and the modding book chapter on Translation.

update_translations.py is an extremely useful tool that can automatically generate and update translation files for mods. Using the -t -O flags are recommended as it will truncate old translated strings that aren't being used anymore.

The Minetest engine translation system

This section is dedicated to developers.

Overview

For most strings, Minetest uses the gettext library to translate the texts in Minetest. To enable internationalization support, the game must be built with the -DENABLE_GETTEXT=1 option to cmake, which is enabled by default.

Games, mods and builtin are translated using a different method (see below).

Language detection

Minetest detects the current language by inspecting the LANG environment variable. This is not a problem on Unix-based systems (such as GNU/Linux) since the system already defines this variable at login. On Windows platforms, the system language is used.

Available translations

The available translations are found in source form in the po/ directory. The cmake detects them, and they are built as part of the build process.

The main translation file must be updated now and then using the this script (configuration, bottom of the file) and this one (C++ and Lua translations). Submit a PR after running the generator or poke a core dev to update the translations when it's needed. Note that builtin translations are handled separately, see the maintenance notes below.

Maintaining engine translations

There are two types of translations that need maintenance: Client-side (using Gettext) and server-side translations for builtin (using minetest.get_translator).

Client-side translations (Gettext)

Contributing a new translation

To create a new translation, one must create a directory named after the language code, creating a copy of the po/minetest.pot file as po/LANG/minetest.po, and translating the original english text into your language; then cmake will detect it and make builds the language.

However, it is recomended to contact a core dev to create the .po file for you language and then use weblate to translate.

Note to coredevs: Creating a new language directly from weblate is sufficient, no need to mess with the files directly in the repository.

How to merge translations from Hosted Weblate

Translations should be merged in bulk, and not too often, to not create too large "noise" in the commit log. A good schedule is once every few months and at the start of the feature freeze. This section explains the necessary steps for coredevs. You will need owner access to the hosted repo in order to be able to push the "Rebase" button.

As of Oct 2019, ShadowNinja, nerzhul, sfan5, rubenwardy, Krock and possibly some other coredevs have such access.

Setting up

Add weblate as remote: git remote add weblate https://hosted.weblate.org/git/minetest/minetest/.

Once every translation

1. Visit Repo maintenance, and lock the repository to prevent changes from users while you are editing.
2. Generate a clean history, without merge commits. Push the "Rebase" button on the repository.
3. Do git remote update weblate. Confirm e.g. with git log --graph weblate/master that it bases on upstream's master, and only has "Translated using Weblate" as additional commits, no merge commits.
4. As every weblate user can freely edit translations, there can be vandalism. Therefore, check the translation commits, e.g. with help from online translator services like Google Translate, other core devs, or trusted members from the community. It might be helpful to push the commits to your GitHub clone's branch, then you have commit http links to share. In the case of required changes, let them do it over the weblate interface (after you've unlocked), and start with 2. again. Of course, its up to you to how much you want to follow this rule, as checking changes can be quite time consuming. Feel free to refine your scope e.g. to new and not yet trusted contributors.
5. Check out the branch from Weblate's repo: git checkout weblate/master
6. Reorder the commits from the same author, and squash them. git rebase -i is your friend (especially after you set it up to show the author, see this Stack Overflow answer on how to do it). As a good tip, rather do multiple runs of such an interactive rebase where you do small changes each, than one big run which then fails in the middle of the business. ./util/reorder_translation_commits.py can do the commit reordering for you.
7. Confirm that git diff weblate/master is empty, to make sure that you didn't mess up at step 6. Otherwise use git reflog to find the latest rebase pass that worked, and retry the commits
8. If required/desired, do these: (--author="updatepo.sh <script@mt>" should be used when committing changes made by the scripts)
   1. Update minetest.conf.example and the dummy *.cpp translation file and commit. Do this by uncommenting the lines at the end of builtin/mainmenu/settings/init.lua
   2. Run util/updatepo.sh, and commit. Note that it creates lots of unneccessary changes, and enlarges repository size disproportionately, therefore run it even less often.
9. Push to the GitHub repo with e.g. git push origin HEAD:master
10. Reset the Weblate remote ("Reset" button), rebase it to match now current master, and unlock it. If pushed commits do not yet show up in Weblate you may have to press the "Pull" button.

Server-side builtin translations (minetest.get_translator)

The server-side translations of builtin are located in builtin/locale with template.txt being used as the template file.

The template file as well as all locale files need to be updated before release to allow translators to translate.

To update the builtin locale files, run ../util/mod_translation_updater.py from the builtin directory (requires Python 3).

To start a new translation, copy template.txt to create __builtin.<LANGUAGE_CODE>.tr.

Untranslatable texts

Please note: A couple of things in Minetest can not be translated yet:

• Setting help texts for settings of games and mods (settingtypes.txt) (#9070)
• Description of mods, modpacks, games and texture packs (#9071)