(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.

1 files changed, 46 insertions, 0 deletions

diff --git a/docs/obg_format.txt b/docs/obg_format.txt
new file mode 100644
index 000000000..dc8e4221a
--- /dev/null
+++ b/docs/obg_format.txt
@@ -0,0 +1,46 @@
+;
+; Example file for the OpenTTD Base Graphics replacement sets.
+; This file consists of basically two different parts:
+;  * metadata
+;  * information about the files
+;
+; Metadata contains information about the name, version and palette
+; of the graphics set.
+;
+[metadata]
+name         = example  ; the name of the pack, preferably less than 16 characters
+shortname    = XMPL     ; the short name (4 characters), used to identify this set within NewGRFs
+version      = 0        ; the version of this graphics set (read as single integer)
+description  = foo      ; a fairly short description of the set
+palette      = DOS      ; palette used by the set; either DOS or Windows
+
+; The files section lists the files that replace sprites.
+; The file names are case sensitive.
+[files]
+base         = TRG1.GRF     ; GRF file with the base sprites
+logos        = TRGI.GRF     ; GRF file with logos, original terrain generator sprites
+arctic       = TRGC.GRF     ; GRF file with extra arctic sprites
+tropical     = TRGH.GRF     ; GRF file with extra tropical sprites
+toyland      = TRGT.GRF     ; GRF file with extra toyland sprites
+extra        = OPENTTDD.GRF ; NewGRF file using Actions 5, 7, 9 and A to replace sprites
+
+; The md5s section lists the MD5 checksum for the files that replace them.
+; Note that the list of files is case sensitive. Each GRF listed in the
+; files section must be listed here with it's MD5 checksum, otherwise you
+; will get a lot of warnings when starting OpenTTD.
+[md5s]
+TRG1.GRF     = 9311676280e5b14077a8ee41c1b42192
+TRGI.GRF     = da6a6c9dcc451eec88d79211437b76a8
+TRGH.GRF     = ee6616fb0e6ef6b24892c58c93d86fc9
+TRGC.GRF     = ed446637e034104c5559b32c18afe78d
+TRGT.GRF     = fcde1d7e8a74197d72a62695884b909e
+OPENTTDD.GRF = f829f62c137d6d7c6e272c481b796dd5
+
+; The origin section provides the possibility to put and extra line into
+; the warning that a file is missing/corrupt. This can be used to tell
+; them where to find it. It works on the filename specified in the
+; files section and if that is not found it will fall back to the default
+; as shown below here.
+[origin]
+default      = You can find it on your Transport Tycoon Deluxe CD-ROM.
+OPENTTDD.GRF = This file was part of your installation.