gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-01-31 11:23:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
rubidium 2008-09-03 20:51:59 +00:00
parent e6688ab190
commit e7d534c5a6
1 changed files with 38 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/obg_format.txt
View File

@ -7,22 +7,49 @@
; Metadata contains information about the name, version and palette ; Metadata contains information about the name, version and palette
; of the graphics set. ; of the graphics set.
; ;
; == Getting started ==
; - you can't add comments after values
; - you have to fill the MD5 checksum for each file
; - you may not miss any of the metadata or files items
; - `openttd -h` lists all graphics replacements sets it found to be correct
; - `openttd -d grf=1` shows warnings/errors when parsing an .obg file
; - `openttd -I <name>` starts OpenTTD with the given set (case sensitive)
; - adding `graphics_set = <name>` to the misc section of openttd.cfg makes
; OpenTTD start with that graphics set by default
; - there is a command line tool for all platforms called md5sum that can
; create the MD5 checksum you need.
; - all files specified in this file are search relatively to the path where
; this file is found, i.e. if the graphics files are in a subdir you have
; to add that subdir to the names in this file to! It will NOT search for
; a file named like specified in here.
[metadata] [metadata]
name = example ; the name of the pack, preferably less than 16 characters ; the name of the pack, preferably less than 16 characters
shortname = XMPL ; the short name (4 characters), used to identify this set within NewGRFs name = example
version = 0 ; the version of this graphics set (read as single integer) ; the short name (4 characters), used to identify this set within NewGRFs
description = foo ; a fairly short description of the set shortname = XMPL
palette = DOS ; palette used by the set; either DOS or Windows ; the version of this graphics set (read as single integer)
version = 0
; a fairly short description of the set
description = foo
; palette used by the set; either DOS or Windows
palette = DOS
; The files section lists the files that replace sprites. ; The files section lists the files that replace sprites.
; The file names are case sensitive. ; The file names are case sensitive.
[files] [files]
base = TRG1.GRF ; GRF file with the base sprites ; GRF file with the base sprites
logos = TRGI.GRF ; GRF file with logos, original terrain generator sprites base = TRG1.GRF
arctic = TRGC.GRF ; GRF file with extra arctic sprites ; GRF file with logos, original terrain generator sprites
tropical = TRGH.GRF ; GRF file with extra tropical sprites logos = TRGI.GRF
toyland = TRGT.GRF ; GRF file with extra toyland sprites ; GRF file with extra arctic sprites
extra = OPENTTDD.GRF ; NewGRF file using Actions 5, 7, 9 and A to replace sprites arctic = TRGC.GRF
; GRF file with extra tropical sprites
tropical = TRGH.GRF
; GRF file with extra toyland sprites
toyland = TRGT.GRF
; NewGRF file using Actions 5, 7, 9 and A to replace sprites
extra = OPENTTDD.GRF
; The md5s section lists the MD5 checksum for the files that replace them. ; 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 ; Note that the list of files is case sensitive. Each GRF listed in the