docs/obs_format.txt

   1 ;
   2 ; Example file for the OpenTTD Base Sound replacement sets.
   3 ; This file consists of basically two different parts:
   4 ;  * metadata
   5 ;  * information about the files
   6 ;
   7 ; Metadata contains information about the name and version
   8 ; of the sound set.
   9 ;
  10 ; == Getting started ==
  11 ; - you can't add comments after values
  12 ; - you have to fill the MD5 checksum for each file
  13 ; - you may not miss any of the metadata or files items
  14 ; - `openttd -h` lists all sound replacements sets it found to be correct
  15 ; - `openttd -d grf=1` shows warnings/errors when parsing an .obs file
  16 ; - `openttd -S <name>` starts OpenTTD with the given set (case sensitive)
  17 ; - adding `soundsset = <name>` to the misc section of openttd.cfg makes
  18 ;   OpenTTD start with that sound set by default
  19 ; - there is a command line tool for all platforms called md5sum that can
  20 ;   create the MD5 checksum you need.
  21 ; - all files specified in this file are search relatively to the path where
  22 ;   this file is found, i.e. if the sound files are in a subdir you have
  23 ;   to add that subdir to the names in this file to! It will NOT search for
  24 ;   a file named like specified in here.
  25
  26 [metadata]
  27 ; the name of the pack, preferably less than 16 characters
  28 name         = example
  29 ; the short name (4 characters), used to identify this set
  30 shortname    = XMPL
  31 ; the version of this sound set (read as single integer)
  32 version      = 0
  33 ; a fairly short description of the set
  34 ; By adding '.<iso code>' you can translate the description.
  35 ; Note that OpenTTD first tries the full ISO code, then the first
  36 ; two characters and then uses the fallback (no '.<iso code>').
  37 ; The ISO code matching is case sensitive!
  38 ; So en_US will be used for en_GB if no en_GB translation is added.
  39 ; As a result the below example has 'howdie' for en_US and en_GB but
  40 ; 'foo' for all other languages.
  41 description  = foo
  42 description.en_US = howdie
  43
  44 ; The files section lists the files that replace sprites.
  45 ; The file names are case sensitive.
  46 [files]
  47 ; The file with the samples. Must contain exactly 73 samples.
  48 samples      = SAMPLES.CAT
  49
  50 ; The md5s section lists the MD5 checksum for the files that replace them.
  51 ; Note that the list of files is case sensitive. Each file listed in the
  52 ; files section must be listed here with it's MD5 checksum, otherwise you
  53 ; will get a lot of warnings when starting OpenTTD.
  54 [md5s]
  55 SAMPLES.CAT  = 422ea3dd074d2859bb51639a6e0e85da
  56
  57 ; The origin section provides the possibility to put and extra line into
  58 ; the warning that a file is missing/corrupt. This can be used to tell
  59 ; them where to find it. It works on the filename specified in the
  60 ; files section and if that is not found it will fall back to the default
  61 ; as shown below here.
  62 [origin]
  63 default      = You can find it on your Transport Tycoon Deluxe CD-ROM.
  64 SAMPLES.CAT  = You can find it also on your Transport Tycoon Deluxe CD-ROM.