author | rubidium |
Thu, 18 Dec 2008 12:23:08 +0000 | |
changeset 10436 | 8d3a9fbe8f19 |
parent 10072 | b394c459a682 |
permissions | -rw-r--r-- |
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 |
; |
10072
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
10 |
; == Getting started == |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
11 |
; - you can't add comments after values |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
12 |
; - you have to fill the MD5 checksum for each file |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
13 |
; - you may not miss any of the metadata or files items |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
14 |
; - `openttd -h` lists all graphics replacements sets it found to be correct |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
15 |
; - `openttd -d grf=1` shows warnings/errors when parsing an .obg file |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
16 |
; - `openttd -I <name>` starts OpenTTD with the given set (case sensitive) |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
17 |
; - adding `graphics_set = <name>` to the misc section of openttd.cfg makes |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
18 |
; OpenTTD start with that graphics set by default |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
19 |
; - there is a command line tool for all platforms called md5sum that can |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
20 |
; create the MD5 checksum you need. |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
21 |
; - all files specified in this file are search relatively to the path where |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
22 |
; this file is found, i.e. if the graphics files are in a subdir you have |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
23 |
; to add that subdir to the names in this file to! It will NOT search for |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
24 |
; a file named like specified in here. |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
25 |
|
10037
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
26 |
[metadata] |
10072
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
27 |
; the name of the pack, preferably less than 16 characters |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
28 |
name = example |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
29 |
; the short name (4 characters), used to identify this set within NewGRFs |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
30 |
shortname = XMPL |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
31 |
; the version of this graphics set (read as single integer) |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
32 |
version = 0 |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
33 |
; a fairly short description of the set |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
34 |
description = foo |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
35 |
; palette used by the set; either DOS or Windows |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
36 |
palette = DOS |
10037
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
37 |
|
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
38 |
; 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
|
39 |
; 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
|
40 |
[files] |
10072
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
41 |
; GRF file with the base sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
42 |
base = TRG1.GRF |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
43 |
; GRF file with logos, original terrain generator sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
44 |
logos = TRGI.GRF |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
45 |
; GRF file with extra arctic sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
46 |
arctic = TRGC.GRF |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
47 |
; GRF file with extra tropical sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
48 |
tropical = TRGH.GRF |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
49 |
; GRF file with extra toyland sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
50 |
toyland = TRGT.GRF |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
51 |
; NewGRF file using Actions 5, 7, 9 and A to replace sprites |
b394c459a682
(svn r14240) -Doc: add a few pointers/"howto"-ish lines to the obg format documentation about what it does and does not do and how you should fill the data.
rubidium
parents:
10037
diff
changeset
|
52 |
extra = OPENTTDD.GRF |
10037
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
53 |
|
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
54 |
; 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
|
55 |
; 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
|
56 |
; 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
|
57 |
; 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
|
58 |
[md5s] |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
59 |
TRG1.GRF = 9311676280e5b14077a8ee41c1b42192 |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
60 |
TRGI.GRF = da6a6c9dcc451eec88d79211437b76a8 |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
61 |
TRGH.GRF = ee6616fb0e6ef6b24892c58c93d86fc9 |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
62 |
TRGC.GRF = ed446637e034104c5559b32c18afe78d |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
63 |
TRGT.GRF = fcde1d7e8a74197d72a62695884b909e |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
64 |
OPENTTDD.GRF = f829f62c137d6d7c6e272c481b796dd5 |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
65 |
|
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
66 |
; 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
|
67 |
; 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
|
68 |
; 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
|
69 |
; 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
|
70 |
; as shown below here. |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
71 |
[origin] |
a06670f961a8
(svn r14197) -Codechange: rework (original) base graphics determination methods. This yields in the following:
rubidium
parents:
diff
changeset
|
72 |
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
|
73 |
OPENTTDD.GRF = This file was part of your installation. |