docs/obg_format.txt

   1 ;
   2 ; Example file for the OpenTTD Base Graphics 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, version and palette
   8 ; of the graphics 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 graphics replacements sets it found to be correct
  15 ; - `openttd -d grf=1` shows warnings/errors when parsing an .obg file
  16 ; - `openttd -I <name>` starts OpenTTD with the given set (case sensitive)
  17 ; - adding `graphicsset = <name>` to the misc section of openttd.cfg makes
  18 ;   OpenTTD start with that graphics 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 graphics 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 graphics 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 ; palette used by the set; either DOS or Windows
  44 palette      = DOS
  45 ; preferred blitter, optional; either 8bpp (default) or 32bpp.
  46 blitter      = 8bpp
  47
  48 ; The files section lists the files that replace sprites.
  49 ; The file names are case sensitive.
  50 [files]
  51 ; GRF file with the base sprites
  52 base         = TRG1.GRF
  53 ; GRF file with logos, original terrain generator sprites
  54 logos        = TRGI.GRF
  55 ; GRF file with extra arctic sprites
  56 arctic       = TRGC.GRF
  57 ; GRF file with extra tropical sprites
  58 tropical     = TRGH.GRF
  59 ; GRF file with extra toyland sprites
  60 toyland      = TRGT.GRF
  61 ; NewGRF file using Actions 5, 7, 9 and A to replace sprites
  62 ; Must use a GRF ID starting with FF so it cannot be selected from
  63 ; the in-game NewGRF list and (thus) be loaded twice.
  64 extra        = OPENTTDD.GRF
  65
  66 ; The md5s section lists the MD5 checksum for the files that replace them.
  67 ; Note that the list of files is case sensitive. Each GRF listed in the
  68 ; files section must be listed here with it's MD5 checksum, otherwise you
  69 ; will get a lot of warnings when starting OpenTTD.
  70 [md5s]
  71 TRG1.GRF     = 9311676280e5b14077a8ee41c1b42192
  72 TRGI.GRF     = da6a6c9dcc451eec88d79211437b76a8
  73 TRGH.GRF     = ee6616fb0e6ef6b24892c58c93d86fc9
  74 TRGC.GRF     = ed446637e034104c5559b32c18afe78d
  75 TRGT.GRF     = fcde1d7e8a74197d72a62695884b909e
  76 OPENTTDD.GRF = f829f62c137d6d7c6e272c481b796dd5
  77
  78 ; The origin section provides the possibility to put and extra line into
  79 ; the warning that a file is missing/corrupt. This can be used to tell
  80 ; them where to find it. It works on the filename specified in the
  81 ; files section and if that is not found it will fall back to the default
  82 ; as shown below here.
  83 [origin]
  84 default      = You can find it on your Transport Tycoon Deluxe CD-ROM.
  85 OPENTTDD.GRF = This file was part of your installation.