docs/compiling_lang_files.md

   1 # How to compile lang files (OpenTTD and strgen)
   2
   3 Last updated:    2009-06-30
   4
   5 ## strgen usage
   6
   7 This guide is only interesting for people who want to alter something
   8 themselves without access to [translator.openttd.org](https://translator.openttd.org/).
   9
  10 Please note that your compiled language file will only be compatible with the OpenTTD version
  11 you have downloaded `english.txt`, the master language file, for. While this is
  12 not always true, namely when changes in the code have not touched language
  13 files, your safest bet is to assume this 'limitation'.
  14
  15 As a first step you need to compile strgen. This is as easy as typing
  16 `'make strgen'`. You can download the precompile strgen from:
  17 [http://www.openttd.org/download-strgen](http://www.openttd.org/download-strgen)
  18
  19 strgen takes as argument a txt file and translates it to a lng file, allowing
  20 it to be used inside OpenTTD. strgen needs the master language file
  21 `english.txt` to work. Below are some examples of strgen usage.
  22
  23 ## Examples
  24
  25 ### Example 1
  26
  27 If you are in the root of your working copy (git repository), you should type
  28 `./strgen/strgen -s lang lang/english.txt`
  29 to compile `english.txt` into `english.lng`. It will be placed in the lang dir.
  30
  31 ### Example 2
  32
  33 You only have the strgen executable (no working copy) and you want to compile
  34 a txt file in the same directory. You should type
  35 `./strgen english.txt`
  36 and you will get and `english.lng` in the same dir.
  37
  38 ### Example 3
  39
  40 You have strgen somewhere, `english.txt` in `/usr/openttd/lang` and you want the
  41 resulting language file to go to /tmp. Use
  42 `./strgen -s /usr/openttd/lang -d /tmp english.txt`
  43
  44 You can interchange `english.txt` to whichever language you want to generate a
  45 .lng file for.
  46
  47 ## strgen command switches
  48
  49 `-v | --version`
  50 strgen will tell what git revision it was last modified
  51
  52 `-t | --todo`
  53 strgen will add <TODO> to any untranslated/missing strings and use the english
  54 strings while compiling the language file
  55
  56 `-w | --warning`
  57 strgen will print any missing strings or wrongly translated (bad format)
  58 to standard error output(stderr)
  59
  60 `-h | --help | -?`
  61 Print out a summarized help message explaining these switches
  62
  63 `-s | --source_dir`
  64 strgen will search for the master file english.txt in the directory specified
  65 by this switch instead of the current directory
  66
  67 `-d | --dest_dir`
  68 strgen will put <language>.lng in the directory specified by this switch; if
  69 no dest_dir is given, output is the same as source_dir