Translating

Every text in BlockFactory comes from a language file, so the mod can be translated without any coding. English is the reference, German is complete, and every other language is welcome, even if it is only partly done: lines that are not translated yet show up in English in the game.

Where the translations live

The language files are in the BlockFactory-Wiki repository, the same repository this wiki belongs to:

Languages/
  en-US/blockfactory.lang        English reference: every key exists here
  de-DE/blockfactory.lang        German
  <code>/blockfactory.lang       one folder per language
ExampleLanguages/
  example-EXAMPLE/blockfactory.lang   empty template for a new language

Each line is one text: key = text. You translate only the part after the =.

How to help

• Start a new language or improve an existing one with a pull request.
• Report a mistake with an issue: name the key (the part before the =) and what is wrong.
• English texts are copied from the mod with every release, so please report English mistakes as an issue instead of changing en-US.

The full guide, with the rules for placeholders like {name}, plural forms and the words you must not translate (commands, the Programmable Interface language), is in CONTRIBUTING.md.

Folder name

The folder must be named exactly like the language code of the Hytale client, for example fr-FR or pt-BR. Upper and lower case matter. You find the codes in your Hytale installation under Client/Data/Shared/Language/.

When does my translation show up in the game?

Translations are packed into the mod with the next release after your pull request is merged.