LOCALIZATION INSTRUCTIONS v1.0 -- 28 August 2015

Radiator (this family of games) supports localization and translation via text files. The basic implementation is:

1) Text files should use "UTF-8 (without BOM)" encoding.  (I use Notepad++ which can easily do this)

2) On Windows / Linux, put text files in "<path to executablename_Data folder>/languages/" ... On Mac OSX, put text files in "<path to player app bundle>/Contents/languages/" (e.g. Windows might be "C:\Games\RinseAndRepeat\RinseAndRepeat_Data\languages\")

3) Files must be named exactly as the language name appears on http://docs.unity3d.com/ScriptReference/SystemLanguage.html (e.g. Simplified Chinese must be named "ChineseSimplified.txt")

4) Restart the game to reload the language dictionaries.

Unfortunately, if your language is not listed on that Unity docs page http://docs.unity3d.com/ScriptReference/SystemLanguage.html then the game cannot recognize your language. Sorry.

******

HOW IT WORKS IN-GAME

a) when you start the game, it detects the user's language (e.g. "French")
b) every piece of game text starts as a placeholder token (e.g. "#hello")
c) ... and then the game looks in the correct text files (e.g. "French.txt")
d) ... and swaps the token for translated text (e.g. #hello >> "Bonjour.")

******

TEXT FILE FORMAT

The text file structure is made of three parts: comments, tokens, and text. Sometimes, there are different texts. Each possibility is separated with a "|"

// this is a comment, it is ignored by the game engine
#ThisIsAToken
This is text that will appear.|Variant of the same text.|The game picks one randomly.

******

MORE NOTES ON FORMATTING:

- Do not put a trailing "|" at the end of a text line, that might break the game.
- Maintain the same number of "|" as in the English version, or else the game might break.
- All tokens and text must be on one line. For line breaks, type "\n".

******

SUGGESTED WORKFLOW

0) Play the game first, so you understand how this text appears in-game. Enable subtitles in the Settings / Options menu.

1) Make copies of the English.txt files, and rename them to your language. Refer to the file naming guide at the top.

2) Keep a copy of the English text (maybe as a comment?) for reference.

3) Translate mainly for UNDERSTANDING. Use native cultural equivalents, do not literally translate English slang that makes no sense in other languages.

******

SENDING ME TRANSLATIONS / QUESTIONS?

If you've done a translation, or if you have any questions about anything, then please e-mail me at yang[dot]robert[dot]w<at>gmail[dot]com

Then I can add your translation to future release so that everyone can enjoy the game in your language. The world will thank you, and I will thank you. If/when I do a commercial release for $$$, like on Steam, I'll definitely try to compensate you somehow.

