Difference between revisions of "Internationalization"

From The DarkMod Wiki
Jump to navigationJump to search
m (fix markup)
m (typo)
Line 48: Line 48:
</pre>
</pre>


Example dictionary, not the entire content is wrapped in "{ }"
Example dictionary, note the entire content is wrapped in "{ }"


<pre>
<pre>

Revision as of 10:07, 20 August 2011

This article deals with the localisation/translation of both TDM itself, as well as Fan Missions.

The I18N support in TDM will only work with v1.07 or newer.

For Users

You can switch the language of TDM in the Settings menu under Video, General. The language is stored in the CVAR tdm_lang. Ignore the CVAR sys_lang.

Switching the language does not require a newstart, except for some languages like Russian. There the game will inform you that you need to restart it manually, or the display will not look correct.

Changing the language will change the language of the HUD, as well as the inventory immidiately. It can also be done during a mission.

Note: Not all FMs are yet multi-lingual, and for these certain inventory items, the objectives, or readables might appear in English.

For Mappers

As a mapper, you want to reach an audience as wide as possible with your FM. One way is to provide alternative language versions of your map. There are two ways that can be achieved:

  1. You can ignore the issue, and hope that somebody else modifies your FM and provides a translation. The past shows that the changes that someone does this are slim, tho. Only a handful of FMs were every translated, most of them only into one other languages. That is because modifying and translating an FM are quite a lot of work, and translators would rather just translate things than to muck around with your PK4 file.
  2. You can (from v1.07 on) build in support for translation from the beginning, and make the work for translators easier.

The second point can achieved in two ways:

  1. You build the FM with hard-coded strings like 'Silver Key', and then use a script to transform the FM into a package that can have external dictionaries. That might be easier to work with in DR (as DR itself has no support for dictionaries yet), but the script might not be 100% correct and you need to manually help it out. The script is not yet completely written, either.
  2. You build your FM with string templates like "#str_12345" instead of hard-coded names, and supply an external dictionary with these strings.

FM specific dictionaries

These dictionaries live in the directory strings/fm/ and must follow a specific format, explained below. The name for such a dictionary is always LANGUAGE.lang, f.i. "english.lang".

You MUST also separate them from the rest of your FM into their own package called "YOURFM_i18n.pk4" where YOURFM is the name of your original PK4 file.

Let's see how this looks for the FM named "outpost", which provides two translations (English and French):

 outpost.pk4:

  xdata/outpost.xd
  maps/outpost.map
  maps/outpost.cm
  maps/outpost.proc
  maps/outpost.script
  maps/outpost.aas32

outpost_i18n.pk4

  strings/fm/english.lang

Example dictionary, note the entire content is wrapped in "{ }"

// String table english (iso-8859-1) for: The Outpost

// This file was generated automatically on 2011-08-20 13:56 UTC by fm_translate.pl v0.01

{
        "#str_20000"    "The Outpost"
        "#str_20001"    "Break into a builder outpost to retrieve a gold ingot."
        "#str_20002"    "Gold Ingot"
        "#str_20003"    "Leave the outpost after your main objectives are done and get back to the front gates."
        "#str_20004"    "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 600."
        "#str_20005"    "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 700."
        "#str_20006"    "No knock outs too."
        "#str_20007"    "Killing is not your style. No corpses tonight."
        "#str_20008"    "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 800."
        "#str_20009"    "The massive gold ingot should be worth a fair amount of money. Find out where the ingot is kept and change its ownership."
}

This setup makes it easier to translate the FM, because an translator needs only to copy english.lang to german.lang, change the strings, repackage the outpost_i18n.pk4 file, and it works!


Inventory Item Names with multiple lines

If you have an inventor item name which is very long, you can insert \n to split it up into two (but not more!) lines:

"inv_name" "This is a very very\nlong item name."

You should try in game how it looks, so that both lines are roughly the same length.

For Developers

CVAR tdm_lang

The D3 CVAR sys_lang is restricted to a few hard-coded values, and is thus not usable. We have added a new CVAR tdm_lang, which contains the current language as English lower-case string, e.g. "english", "german", "portuguese" etc. This variable is controlled by the GUI via a call back into the SDK code, which switches the language underneath, and also reloads the GUI.

If you change the CVAR manually (via the console f.i.), you need to restart TDM so it works!

Code

The main translation object is of the class CI18N (which is short for "Class Internationalization") and lives in Darkmod/I18N.cpp and Darkmod/I18N.h.

Known bugs

Sadly, there are quite a lot of limitations in the D3 SDK that prevent a few things from fully working. Once D3 goes open source, these things will be fixed, in the meantime we hope that you can live with the quirks.

TODO

See also