author Wuzzy
Thu, 21 Sep 2017 17:06:31 +0100
changeset 1034 f55656ceb224
parent 1024 f243d261e679
child 1035 8d69a25f70cc
permissions -rw-r--r--
Translations: Explain the syntax of txt files

#summary This is a guide for new translators.

= Translations =
== Introduction ==

This is a guide for translators. In order to translate Hedgewars into another language you are going to need:

 # The latest Hedgewars localization files
 # A text editor like Notepad++, Geany, Vim, etc.
 # Qt4 Linguist. To download the Qt4 Linguist you have to download the Qt4 SDK.

== Getting the localization files ==

To get the Hedgewars localization files there are 4 possible ways.

 * *A*. Clone the Hedgewars source repository.
 * *B*. Download the latest Hedgewars source code.
 * *C*. Find the localization files in your current Hedgewars installation.
 * *D*. Download only the specific files to be translated.

The *A* is maybe the most convenient way to include the translations in the next Hedgewars release as you can easily produce a patch to provide it to the Hedgewars developers. Note that a fast internet connection is desired as you probably will clone the whole game sources. The other advantage of this way is that it can be used to translate the latest game version that is going to be released.

The *B* way is a lot like the *A* way but more limited.

The *C* is probably the fastest way and the more convenient for the translator.
However, it has the limitation that one can only translate the most recent Hedgewars release (the one currently installed) and not the version that is going to be released.

The *D* way is to download the desired files from [ here].

Above I am going to discuss the *C* way (Find the localization files in your current Hedgewars installation).

=== Finding the localization files ===

In GNU/Linux you have to look into `/path-to-Hedgewars/Data/Locale where path-to-Hedgewars` is the path to your Hedgewars installation.

In Windows you have to look into `c:\path-to-Hedgewars\share\Hedgewars\Data\Locale` where path-to-Hedgewars is the path to your Hedgewars installation.

For example in an Arch Linux box the path is `/usr/share/Hedgewars/Data/Locale`.
In a Windows 8 box the path is `C:\Program Files (x86)\Hedgewars 0.9.19\Data\Locale`.

== Translation files ==
Here is a list of the different localization files of the English language that you should use as your translation reference/template as it should be the most accurate and up to date. The file locations are relative to the top directory of the Hedgewars source code. You can edit all these files with a text editor, but for some files special editors are available.

=== Engine (in-game stuff) ===
 * `/share/hedgewars/Data/Locale/en.txt`—This contains the core in-game strings, such as the mission panel, the messages at the top, ammo names and descriptions (see below)
 * `/share/hedgewars/Data/Locale/stub.lua`—Strings used by Lua scripts, which includes campaigns, missions and game styles (see below)

==== `.txt` files ====
A `.txt` file is organized in lines and string identifiers. Each string is identified with two numbers like `01:05`. The first number is called the “group”.

Each line follows this format:


For example:


See `en.txt` for the English original texts. Note that some of the numbers may be missing in your file, so you need to add them on your own.

The group `02` is special because texts can be repeated here. These texts are used for event messages like the death of a hedgehog (`02:00`). Hedgewars will randomly use any of these messages in the same group. Each language can have its own set of messages for this. Translations can be rather flexible here.
In `02`, you don't need to translate every English message, but try to do your best. It is OK to omit messages if a direct translation wouldn't make sense (e.g. for weird English idioms). You can also invent your messages which are more appropriate for your language. If you're in a hurry, you can just add single a single message for each of the `02` groups (`02:00`, `02:01`, `02:02`, etc.), but don't forget to finish it later. Hedgewars will only use the messages in your language file here.

In the `04` and `05` groups, you can use two special characters:
The `|` character is used as a line break.
Also, for each line, all text written before a colon (`:`) including the colon itself will be highlighted.

Don't forget to test these texts in-game to make sure everything looks fine.

==== `.lua` files ====
In a `.lua` file you will find many lines like this:

```["Rubber Band"] = "", -- Construction_Mode```

Those need to be translated. The part in square brackets is the English original text.
The part in the quotation marks after the equals sign is supposed to contain the translation.
The part after the two dashes is a comment to provide context. It is only present for orientation, you do not need to translate it, you can also remove it. In this example, it means that the text comes from the Construction Mode script.

Example for a translated line (in Italian):

```["Rounds Complete"] = "Round Completati",```

Lines which look different than the lines described above have a special meaning and must not be changed.
In case you need to include a quotation mark in your translation, write `\"` instead of `"`.
Lines beginning with two dashes can be ignored.

Note to programmers: These `.lua` files are actually containing real Lua source code.

=== Frontend (main menu) ===
 * `/share/hedgewars/Data/Locale/hedgewars_en.ts`—Contains most strings of the frontend and you can edit it with Qt Linguist
 * `/share/hedgewars/Data/Locale/missions_en.txt`—This is the [Missions mission] description strings
 * `/share/hedgewars/Data/Locale/campaigns_en.txt`—This is the campaign description strings
 * `/share/hedgewars/Data/Locale/tips_en.xml`—This contains the tips shown in the main menu. This file is *not* in XML format!

==== Mission map descriptions ====
The map selection shows brief descriptions for mission maps below the preview image. Those can be translated and you find those texts in:

 * `/share/hedgewars/Data/Maps/<map name>/desc.txt`

Replace “`<map name`>” with the name of any mission map. You see a list of mission maps if you select the map type “mission map” when preparing a game.

To translate these, add a line of the format `language code=description` (e.g. “en=This is an example.” for English). Since version 0.9.23, you must use the following special character sequences for new lines, commas and underscores:

|| *Written text* || *Is replaced by* ||
|| `_n` || New line ||
|| `_c` || Comma ||
|| `__` || Underscore ||

=== Metadata ===
The following files are not used by Hedgewars itself, but they contain translatable metadata about Hedgewars:

 * `/share/hedgewars/Data/misc/hedgewars.desktop`—[ Desktop Entry] file for the Hedgewars application
 * `/share/hedgewars/Data/misc/`—Desktop Entry file for the Hedgewars engine for playing savegames and demos
 * `/share/hedgewars/Data/misc/hwengine.desktop`—*Do not translate*! This file will be automatically generated from `` when building Hedgewars
 * `/share/hedgewars/Data/misc/hedgewars-mimeinfo.xml`—Description of Hedgewars file types

== Updating an existing translation ==

That is relatively easy. Just edit the existing file. You can edit every file with your favorite editor and the `.ts` file with Qt Linguist.

The `en.lua` file doesn’t exist. The strings are hard coded in the code.

== Creating a new translation ==

That is easy, too. Make a copy of the English file and rename it to use the initials of your language.

The `en.lua` file doesn’t exist. Use `stub.lua` instead as your template.

Here are 3 examples:

 * For French copy `en.txt` to `fr.txt`
 * For Spanish copy `en.txt` to `es.txt`
 * For Greek copy `en.txt` to `el.txt`

== Testing the translations ==

When finished you have just to start Hedgewars and choose your language from the Game Preferences, Advanced tab.

If a translation is missing then the string is going to be displayed in English.
Note that you should restart the frondend for the language changes to take effect.

== Sharing the translations ==

In order to share your translations with Hedgewars community there are 3 possible ways:

 # Give them the files and tell them where to place them. Of course this is the less convenient way but it is maybe a good approach to let other players double-check your translations
 # Talk with a Hedgewars developer in order to include it in the next Hedgewars release
 # Talk with a Hedgewars developer in order to include it in [ DLC]

== Things to have in mind ==

If you are going to make a translation for a next Hedgewars release strings may not be frozen yet and change before the release. Better ask in irc in cases like that.