docs/obm_format.txt

   1 ;
   2 ; Example file for the OpenTTD Base Music replacement sets.
   3 ; This file consists of basically two different parts:
   4 ;  * metadata
   5 ;  * information about the files/songs
   6 ;
   7 ; Metadata contains information about the name and version
   8 ; of the music 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 music replacement sets it found to be correct
  15 ; - `openttd -d grf=1` shows warnings/errors when parsing an .obm file
  16 ; - `openttd -M <name>` starts OpenTTD with the given set (case sensitive)
  17 ; - adding `musicset = <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 songs.
  45 ; The file names are case sensitive.
  46 ; You can have empty file names; in that case no song will be loaded
  47 ; for that 'entry'.
  48 ; If you want to load music from the MPS DOS music driver "cat" format,
  49 ; specify just the name of the .cat file the song is located in, then
  50 ; fill out the "catindex" section.
  51 [files]
  52 ; The theme song for OpenTTD
  53 theme = THEME_SONG.GM
  54 ; The songs in the 'old style' category
  55 old_0 = GM.CAT
  56 old_1 = GM.CAT
  57 old_2 =
  58 old_3 =
  59 old_4 =
  60 old_5 =
  61 old_6 =
  62 old_7 =
  63 old_8 =
  64 old_9 =
  65 ; The songs in the 'new style' category
  66 new_0 =
  67 new_1 =
  68 new_2 =
  69 new_3 =
  70 new_4 =
  71 new_5 =
  72 new_6 =
  73 new_7 =
  74 new_8 =
  75 new_9 =
  76 ; The songs in the 'ezy street' category
  77 ezy_0 =
  78 ezy_1 =
  79 ezy_2 =
  80 ezy_3 =
  81 ezy_4 =
  82 ezy_5 =
  83 ezy_6 =
  84 ezy_7 =
  85 ezy_8 =
  86 ezy_9 =
  87
  88 ; The names section lists the song names for the given file name.
  89 ; Note that the list of files is case sensitive. Each file listed in the
  90 ; files section must be listed here with it's song name, otherwise you
  91 ; will get a lot of warnings when starting OpenTTD.
  92 ; You don't need to fill this out for "cat" format music, the song names
  93 ; are loaded directly from the file in that case.
  94 [names]
  95 THEME_SONG.GM = Tycoon DELUXE Theme
  96
  97 ; If you are loading music from the DOS version "cat" format, specify
  98 ; which index into the file the song has.
  99 [catindex]
 100 old_0 = 1
 101 old_1 = 3
 102
 103 ; The md5s section lists the MD5 checksum for the files that replace them.
 104 ; Note that the list of files is case sensitive. Each file listed in the
 105 ; files section must be listed here with it's MD5 checksum, otherwise you
 106 ; will get a lot of warnings when starting OpenTTD.
 107 [md5s]
 108 THEME_SONG.GM = 45cfec1b9d8c7a0ad45e755833cbf221
 109
 110 ; If a song needs to have parts of the start or end cut off to avoid long
 111 ; silences, you can specify MIDI tick codes for start:end of the actual
 112 ; music part for each file here.
 113 ; Not all music drivers might support this feature.
 114 [timingtrim]
 115 THEME_SONG.GM = 768:53760
 116
 117 ; The origin section provides the possibility to put and extra line into
 118 ; the warning that a file is missing/corrupt. This can be used to tell
 119 ; them where to find it. It works on the filename specified in the
 120 ; files section and if that is not found it will fall back to the default
 121 ; as shown below here.
 122 [origin]
 123 default       = You can find it on your Transport Tycoon Deluxe CD-ROM.
 124 THEME_SONG.GM  = You can find it also on your Transport Tycoon Deluxe CD-ROM.