docs/obg_format.txt
author rubidium
Sun, 31 Aug 2008 08:46:43 +0000
changeset 10037 a06670f961a8
child 10072 b394c459a682
permissions -rw-r--r--
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
-Feature: make configuring the to-be-used base graphics via openttd.cfg and the command line possible.
-Feature: allow both the German as well as non-German toyland graphics as "correct" and official graphics.
-Feature: allow people to create their own base graphics easily and without requiring code changes.
10037
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     1
;
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     2
; Example file for the OpenTTD Base Graphics replacement sets.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     3
; This file consists of basically two different parts:
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     4
;  * metadata
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     5
;  * information about the files
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     6
;
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     7
; Metadata contains information about the name, version and palette
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     8
; of the graphics set.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
     9
;
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    10
[metadata]
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    11
name         = example  ; the name of the pack, preferably less than 16 characters
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    12
shortname    = XMPL     ; the short name (4 characters), used to identify this set within NewGRFs
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    13
version      = 0        ; the version of this graphics set (read as single integer)
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    14
description  = foo      ; a fairly short description of the set
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    15
palette      = DOS      ; palette used by the set; either DOS or Windows
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    16
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    17
; The files section lists the files that replace sprites.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    18
; The file names are case sensitive.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    19
[files]
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    20
base         = TRG1.GRF     ; GRF file with the base sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    21
logos        = TRGI.GRF     ; GRF file with logos, original terrain generator sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    22
arctic       = TRGC.GRF     ; GRF file with extra arctic sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    23
tropical     = TRGH.GRF     ; GRF file with extra tropical sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    24
toyland      = TRGT.GRF     ; GRF file with extra toyland sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    25
extra        = OPENTTDD.GRF ; NewGRF file using Actions 5, 7, 9 and A to replace sprites
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    26
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    27
; The md5s section lists the MD5 checksum for the files that replace them.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    28
; Note that the list of files is case sensitive. Each GRF listed in the
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    29
; files section must be listed here with it's MD5 checksum, otherwise you
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    30
; will get a lot of warnings when starting OpenTTD.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    31
[md5s]
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    32
TRG1.GRF     = 9311676280e5b14077a8ee41c1b42192
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    33
TRGI.GRF     = da6a6c9dcc451eec88d79211437b76a8
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    34
TRGH.GRF     = ee6616fb0e6ef6b24892c58c93d86fc9
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    35
TRGC.GRF     = ed446637e034104c5559b32c18afe78d
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    36
TRGT.GRF     = fcde1d7e8a74197d72a62695884b909e
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    37
OPENTTDD.GRF = f829f62c137d6d7c6e272c481b796dd5
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    38
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    39
; The origin section provides the possibility to put and extra line into
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    40
; the warning that a file is missing/corrupt. This can be used to tell
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    41
; them where to find it. It works on the filename specified in the
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    42
; files section and if that is not found it will fall back to the default
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    43
; as shown below here.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    44
[origin]
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    45
default      = You can find it on your Transport Tycoon Deluxe CD-ROM.
a06670f961a8 (svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff changeset
    46
OPENTTDD.GRF = This file was part of your installation.