| blob | 40f829a5223f873388cddc48d504e8463d397b2d |
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.
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
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 [files]
49 ; The theme song for OpenTTD
50 theme = THEME_SONG.GM
51 ; The songs in the 'old style' category
52 old_0 =
53 old_1 =
54 old_2 =
55 old_3 =
56 old_4 =
57 old_5 =
58 old_6 =
59 old_7 =
60 old_8 =
61 old_9 =
62 ; The songs in the 'new style' category
63 new_0 =
64 new_1 =
65 new_2 =
66 new_3 =
67 new_4 =
68 new_5 =
69 new_6 =
70 new_7 =
71 new_8 =
72 new_9 =
73 ; The songs in the 'ezy street' category
74 ezy_0 =
75 ezy_1 =
76 ezy_2 =
77 ezy_3 =
78 ezy_4 =
79 ezy_5 =
80 ezy_6 =
81 ezy_7 =
82 ezy_8 =
83 ezy_9 =
85 ; The names section lists the song names for the given file name.
86 ; Note that the list of files is case sensitive. Each file listed in the
87 ; files section must be listed here with it's song name, otherwise you
88 ; will get a lot of warnings when starting OpenTTD.
89 [names]
90 THEME_SONG.GM = Tycoon DELUXE Theme
92 ; The md5s section lists the MD5 checksum for the files that replace them.
93 ; Note that the list of files is case sensitive. Each file listed in the
94 ; files section must be listed here with it's MD5 checksum, otherwise you
95 ; will get a lot of warnings when starting OpenTTD.
96 [md5s]
97 THEME_SONG.GM = 45cfec1b9d8c7a0ad45e755833cbf221
99 ; The origin section provides the possibility to put and extra line into
100 ; the warning that a file is missing/corrupt. This can be used to tell
101 ; them where to find it. It works on the filename specified in the
102 ; files section and if that is not found it will fall back to the default
103 ; as shown below here.
104 [origin]
105 default = You can find it on your Transport Tycoon Deluxe CD-ROM.
106 THEME_SONG.GM = You can find it also on your Transport Tycoon Deluxe CD-ROM.