developer
1,626
edits
Changes
Jump to navigation
Jump to search
→Mods localization support
== Mods localization support ==
From 1.33 mods can add new localization strings. To do this inside directory '''/locale/$language$/''' you have to create localization module. The module file name should be called that way: '''local_module.$mod_name$.sii''' for example '''local_module.mod_awesome_jobs.sii'''. The file must define single unit of class '''localization_db'''. Example Example:
{{Note|$language$ should be tag of language the localization is for, for example: british english is '''en_gb''', american english is '''en_us''', polish is '''pl_pl''', czech is '''cs_cz''' etc.}}
Example:
<pre>
SiiNunit
localization_db : .localization
{
key[]: "chassis" # This is localization token, you can use it by typing @@chassis@@. We recommend to keep them written using lower-case alpha-numeric ASCII characters.
val[]: "Chassis" # This is its value in the language. For every language this value can be different.
</pre>
If you do so your mod should be properly localized now. {{Note|Mods localization cannot override strings that are already defined. That means localization for example of key 'chassis' defined in game main localization will be used first, and if not defined mod with highest priority will be used.}}{{Tip|Our system does not fallback untranslated tokens to english so you have to define localization for all languages supported by the game. Currently game supports following list of the languages.
<pre>bg_bg, ca_es, cs_cz, da_dk, de_de, el_gr, en_gb, en_us, es_es, es_la, et_ee, eu_es, fi_fi, fr_fr, gl_es, hr_hr, hu_hu, it_it, ja_jp, ka_ge, ko_kr, lt_lt, lv_lv, mk_mk, nl_nl, no_no, pl_pl, pl_si, pt_br, pt_pt, ro_ro, ru_ru, sk_sk, sl_sl, sr_sp, sr_sr, sv_se, tr_tr, uk_uk, vi_vn, zh_cn, zh_tw</pre>
If you cannot afford translating your mod to each language we recommend to at least copy english localization to rest of them. If you do so your mod should be properly localized now. {{Tip|$language$ should be name of the language the localization is for for example: british english is '''en_gb''', polish is '''pl_pl''' etc.}}{{Note|Mods localization cannot override strings. That means localization defined by mod with highest priority will be used.}}
