annotate readme.txt @ 13453:ab95ef079c82 draft

(svn r17962) -Fix: some spelling
author rubidium <rubidium@openttd.org>
date Tue, 03 Nov 2009 16:08:18 +0000
parents 1bc00da70d10
children f5704f568df1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
1 OpenTTD README
13172
1bc00da70d10 (svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents: 13063
diff changeset
2 Last updated: 2009-10-01
1bc00da70d10 (svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents: 13063
diff changeset
3 Release version: 0.7.3
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
4 ------------------------------------------------------------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
5
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
6
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
7 Table of Contents:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
8 ------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
9 1.0) About
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
10 2.0) Contacting
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
11 * 2.1 Reporting Bugs
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
12 3.0) Supported Platforms
7686
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
13 4.0) Installing and running OpenTTD
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
14 * 4.1 (Required) 3rd party files
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
15 * 4.2 OpenTTD directories
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
16 * 4.3 Portable Installations (External Media)
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
17 5.0) OpenTTD features
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
18 6.0) Configuration File
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
19 7.0) Compiling
12587
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
20 * 7.1) Required/optional libraries
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
21 8.0) Translating
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
22 * 8.1 Guidelines
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
23 * 8.2 Translation
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
24 * 8.3 Previewing
1703
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
25 9.0) Troubleshooting
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
26 X.X) Credits
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
27
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
28
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
29 1.0) About:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
30 ---- ------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
31 OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
32 written by Chris Sawyer. It attempts to mimic the original game as closely
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
33 as possible while extending it with new features.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
34
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
35 OpenTTD is licensed under the GNU General Public License version 2.0. For
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
36 more information, see the file 'COPYING'.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
37
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
38 2.0) Contacting:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
39 ---- ----------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
40 The easiest way to contact the OpenTTD team is by submitting bug reports or
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
41 posting comments in our forums. You can also chat with us on IRC (#openttd
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
42 on irc.oftc.net).
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
43
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
44 The OpenTTD homepage is http://www.openttd.org/.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
45
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
46 You can also find the OpenTTD forums at
7908
7519c50587e5 (svn r11460) -Documentation: update some documentation to better match the current state and the state in the nearby future of OpenTTD.
rubidium <rubidium@openttd.org>
parents: 7859
diff changeset
47 http://forum.openttd.org/
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
48
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
49
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
50 2.1) Reporting Bugs:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
51 ---- ---------------
13056
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
52 First of all, check whether the bug is not already known. Do this by looking
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
53 through the file called 'known-bugs.txt' which is distributed with OpenTTD
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
54 like this readme.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
55
13056
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
56 For tracking our bugs we are using a bug tracker called Flyspray. You can find
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
57 the tracker at http://bugs.openttd.org/. Before actually reporting take a look
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
58 through the already reported bugs there to see if the bug is already known.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
59 The 'known-bugs.txt' file might be a bit outdated at the moment you are
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
60 reading it as only bugs known before the release are documented there. Also
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
61 look through the recently closed bugs.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
62
13056
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
63 When you are sure it is not already reported you should:
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
64 * Make sure you are running a recent version, i.e. run the latest stable or
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
65 nightly based on where you found the bug.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
66 * Make sure you are not running a non-official binary, like a patch pack.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
67 When you are playing with a patch pack you should report any bugs to the
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
68 forum thread related to that patch pack.
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
69 * Make it reproducible for the developers. In other words, create a savegame
13056
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
70 in which you can reproduce the issue once loaded. It is very useful to give
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
71 us the crash.dmp, crash.sav and crash.log which are created on crashes.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
72 * Check whether the bug is already reported on our bug tracker. This includes
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
73 searching for recently closed bug reports as the bug might already be fixed.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
74
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
75 After you have done all that you can report the bug. Please include the
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
76 following information in your bug report:
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
77 * OpenTTD version (PLEASE test the latest SVN/nightly build)
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
78 * Bug details, including instructions how to reproduce it
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
79 * Platform (Win32, Linux, FreeBSD, ...) and compiler (including version) if
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
80 you compiled OpenTTD yourself.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
81 * Attach a saved game *and* a screenshot if possible
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
82 * If this bug only occurred recently please note the last version without
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
83 the bug and the first version including the bug. That way we can fix it
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
84 quicker by looking at the changes made.
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
85 * Attach crash.dmp, crash.log and crash.sav. These files are usually created
f512ef96e101 (svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents: 12827
diff changeset
86 next to your openttd.cfg. The crash handler will tell you the location.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
87
10515
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
88 2.2) Reporting Desyncs:
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
89 ---- ------------------
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
90 As desyncs are hard to make reproducible OpenTTD has the ability to log all
10515
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
91 actions done by clients so we can replay the whole game in an effort to make
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
92 desyncs better reproducible. You need to turn this ability on. When turned
10515
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
93 on an automatic savegame will be made once the map has been constructed in
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
94 the 'save/autosave' directory, see OpenTTD directories to know where to find
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
95 this directory. Furthermore the log file 'commands-out.log' will be created
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
96 and all actions will be written to there.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
97
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
98 To enable the desync debugging you need to set the debug level for 'desync'
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
99 to at least 1. You do this by starting OpenTTD with '-d desync=<level>' as
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
100 parameter or by typing 'debug_level desync=<level>' in OpenTTD's internal
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
101 console.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
102 The desync debug levels are:
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
103 0: nothing.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
104 1: dumping of commands to 'commands-out.log'.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
105 2: same as 1 plus checking vehicle caches and dumping that too.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
106 3: same as 2 plus monthly saves in autosave.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
107 4 and higher: same as 3
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
108
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
109 Restarting OpenTTD will overwrite 'commands-out.log'. OpenTTD will not remove
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
110 the savegames (dmp_cmds_*.sav) made by the desync debugging system, so you
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
111 have to occasionally remove them yourself!
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
112
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
113 The naming format of the desync savegames is as follows:
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
114 dmp_cmds_XXXXXXXX_YYYYYYYY.sav. The XXXXXXXX is the hexadecimal representation
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
115 of the generation seed of the game and YYYYYYYY is the hexadecimal
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
116 representation of the date of the game. This sorts the savegames by game and
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
117 then by date making it easier to find the right savegames.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
118
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
119 When a desync has occurred with the desync debugging turned on you should file
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
120 a bug report with the following files attached:
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
121 - commands-out.log as it contains all the commands that were done
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
122 - the last saved savegame (search for the last line beginning with
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
123 'save: dmp_cmds_' in commands-out.log). We use this savegame to check
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
124 whether we can quickly reproduce the desync. Otherwise we will need...
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
125 - the first saved savegame (search for the first line beginning with 'save'
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
126 where the first part, up to the last underscore '_', is the same). We need
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
127 this savegame to be able to reproduce the bug when the last savegame is not
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
128 old enough. If you loaded a scenario or savegame you need to attach that.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
129 - optionally you can attach the savegames from around 50%, 75%, 85%, 90% and
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
130 95% of the game's progression. We can use these savegames to speed up the
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
131 reproduction of the desync, but we should be able to reproduce these
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
132 savegames based on the first savegame and commands-out.log.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
133 - in case you use any NewGRFs you should attach the ones you used unless
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
134 we can easily find them ourselves via e.g. grfcrawler or when they are
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
135 in the OpenTTDCoop pack.
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
136
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
137 Do NOT remove the dmp_cmds savegames of a desync you have reported until the
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
138 desync has been fixed; if you, by accident, send us the wrong savegames we
7156262cf0c9 (svn r14772) -Codechange: make the "dump log of game to reproduce" desync debug stuff a runtime configurable debug option instead of a compile time option.
rubidium <rubidium@openttd.org>
parents: 10453
diff changeset
139 will not be able to reproduce the desync and thus will be unable to fix it.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
140
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
141 3.0) Supported Platforms:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
142 ---- --------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
143 OpenTTD has been ported to several platforms and operating systems. It shouldn't
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
144 be very difficult to port it to a new platform. The currently working platforms
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
145 are:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
146
10385
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
147 BeOS - SDL or Allegro
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
148 DOS - Allegro
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
149 FreeBSD - SDL
10385
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
150 Linux - SDL or Allegro
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
151 MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary)
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
152 MorphOS - SDL
6673
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
153 OpenBSD - SDL
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
154 OS/2 - SDL
10385
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
155 Windows - Win32 GDI (faster) or SDL or Allegro
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
156
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
157
7686
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
158 4.0) Installing and running OpenTTD:
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
159 ---- -------------------------------
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
160
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
161 Installing OpenTTD is fairly straightforward. Either you have downloaded an
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
162 archive which you have to extract to a directory where you want OpenTTD to
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
163 be installed, or you have downloaded an installer, which will automatically
48c969ebb8ba (svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents: 7588
diff changeset
164 extract OpenTTD in the given directory.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
165
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
166 OpenTTD looks in multiple locations to find the required data files (described
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
167 in section 4.2). Installing any 3rd party files into a "shared" location has
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
168 the advantage that you only need to do this step once, rather than copying the
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
169 data files into all OpenTTD versions you have.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
170 Savegames, screenshots, etc are saved relative to the config file (openttd.cfg)
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
171 currently being used. This means that if you use a config file in one of the
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
172 shared directories, savegames will reside in the save/ directory next to the
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
173 openttd.cfg file there.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
174 If you want savegames and screenshots in the directory where the OpenTTD binary
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
175 resides, simply have your config file in that location. But if you remove this
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
176 config file, savegames will still be in this directory (see notes in section 4.2)
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
177
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
178 4.1) (Required) 3rd party files:
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
179 ---- ---------------------------
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
180
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
181 Before you run OpenTTD, you need to put the game's data files into a data/
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
182 directory which can be located in various places addressed in the following
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
183 section.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
184 As OpenTTD makes use of the original TTD artwork you will need the files listed
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
185 below, which you can find on a Transport Tycoon Deluxe CD-ROM.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
186 The Windows installer optionally can copy these files from that CD-ROM.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
187
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
188 List of the required files:
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
189 - sample.cat
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
190 - trg1r.grf
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
191 - trgcr.grf
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
192 - trghr.grf
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
193 - trgir.grf
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
194 - trgtr.grf
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
195
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
196 Alternatively you can use the TTD GRF files from the DOS version:
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
197 - TRG1.GRF
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
198 - TRGC.GRF
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
199 - TRGH.GRF
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
200 - TRGI.GRF
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
201 - TRGT.GRF
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
202
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
203 If you want the TTD music, copy the gm/ folder from the Windows version
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
204 of TTD to your OpenTTD folder (not your data folder - also explained in
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
205 the following sections).
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
206
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
207 Do NOT copy files included with OpenTTD into "shared" directories (explained in
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
208 the following sections) as sooner or later you will run into graphical glitches
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
209 when using other versions of the game.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
210
12827
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
211 If you want AIs use the in-game content downloader. If for some reason that is
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
212 not possible or you want to use an AI that has not been uploaded to the content
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
213 download system download the tar file and place it in the ai/ directory. If the
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
214 AI needs libraries you'll have to download those too and put them in the
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
215 ai/library/ directory. All AIs and AI Libraries that have been uploaded to
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
216 the content download system can be found at http://noai.openttd.org/downloads/
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
217 The AIs and libraries can be found their in the form of .tar.gz packages.
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
218 OpenTTD can read inside tar files but it does not extract .tar.gz files by
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
219 itself.
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
220 To figure out which libraries you need for an AI you have to start the AI and
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
221 wait for an error message to pop up. The error message will tell you
864793d914db (svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents: 12777
diff changeset
222 "couldn't find library 'lib-name'". Download that library and try again.
12716
6f69fdced010 (svn r17179) -Merge: changelog etc. changes from 0.7 branch
rubidium <rubidium@openttd.org>
parents: 12587
diff changeset
223
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
224 4.2) OpenTTD directories
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
225 ---- -------------------------------
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
226
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
227 The TTD artwork files listed in the section 4.1 "(Required) 3rd party files"
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
228 can be placed in a few different locations:
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
229 1. The current working directory (from where you started OpenTTD)
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
230 2. Your personal directory
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
231 Windows: C:\Documents and Settings\<username>\My Documents\OpenTTD
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
232 Mac OSX: ~/Documents/OpenTTD
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
233 Linux: ~/.openttd
13172
1bc00da70d10 (svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents: 13063
diff changeset
234 3. The shared directory
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
235 Windows: C:\Documents and Settings\All Users\Documents\OpenTTD
13172
1bc00da70d10 (svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents: 13063
diff changeset
236 Mac OSX: /Library/Application Support/OpenTTD
1bc00da70d10 (svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents: 13063
diff changeset
237 Linux: not available
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
238 4. The binary directory (where the OpenTTD executable is)
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
239 Windows: C:\Program Files\OpenTTD
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
240 Linux: /usr/games
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
241 5. The installation directory (Linux only)
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
242 Linux: /usr/share/games/openttd
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
243 6. The application bundle (Mac OSX only)
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
244 It includes the OpenTTD files (grf+lng) and it will work as long as they aren't touched
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
245
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
246 Notes:
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
247 - Linux in the previous list means .deb, but most paths should be similar for others.
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
248 - The previous search order is also used for NewGRFs and openttd.cfg.
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
249 - If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, 5 order.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
250 - Savegames will be relative to the config file only if there is no save/
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
251 directory in paths with higher priority than the config file path, but
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
252 autosaves and screenshots will always be relative to the config file.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
253
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
254 The preferred setup:
8659
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
255 Place 3rd party files in shared directory (or in personal directory if you don't
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
256 have write access on shared directory) and have your openttd.cfg config file in
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
257 personal directory (where the game will then also place savegames and screenshots).
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
258
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
259
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
260 4.3) Portable Installations (External Media):
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
261 ---- ----------------------------------------
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
262
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
263 You can install OpenTTD on external media so you can take it with you, i.e.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
264 using a USB key, or a USB HDD, etc.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
265 Create a directory where you shall store the game in (i.e. OpenTTD/).
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
266 Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), data/ and your
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
267 openttd.cfg to this directory.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
268 You can copy binaries for any operating system into this directory, which will
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
269 allow you to play the game on nearly any computer you can attach the external
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
270 media to.
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
271 As always - additional grf files are stored in the data/ dir (for details,
8a48f9c9188e (svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents: 8605
diff changeset
272 again, see section 4.1).
614
96f116271012 (svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik <dominik@openttd.org>
parents: 504
diff changeset
273
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
274
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
275 5.0) OpenTTD features:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
276 ---- -----------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
277
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
278 OpenTTD has a lot of features going beyond the original TTD emulation.
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
279 Unfortunately, there is currently no comprehensive list of features, but there
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
280 is a basic features list on the web, and some optional features can be
11069
36d798171bfd (svn r15410) -Cleanup: get rid of most of the references to the 'patches' except where it's used for backward compatability.
rubidium <rubidium@openttd.org>
parents: 10583
diff changeset
281 controlled through the Advanced Settings dialog. We also implement some
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
282 features known from TTDPatch (http://www.ttdpatch.net/).
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
283
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
284 Several important non-standard controls:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
285
12125
dd5b77965bb5 (svn r16541) -Merge: changelog etc. changes from 0.7 branch
rubidium <rubidium@openttd.org>
parents: 11372
diff changeset
286 * Ctrl makes many commands more powerful. For example Ctrl clicking on signals
dd5b77965bb5 (svn r16541) -Merge: changelog etc. changes from 0.7 branch
rubidium <rubidium@openttd.org>
parents: 11372
diff changeset
287 with the build signal tool changes their behaviour.
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
288 * Ingame console. More information at
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
289 http://wiki.openttd.org/index.php/Console
11372
371d9d118d1d (svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents: 11369
diff changeset
290 * Right clicking shows tooltips
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
291
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
292
9457
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
293 5.1) Logging of potentially dangerous actions:
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
294 ---- ----------------------------------------
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
295
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
296 OpenTTD is a complex program, and together with NewGRF, it may show a buggy
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
297 behaviour. But not only bugs in code can cause problems. There are several
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
298 ways to affect game state possibly resulting in program crash or multiplayer
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
299 desyncs.
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
300 Easier way would be to forbid all these unsafe actions, but that would affect
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
301 game usability for many players. We certainly do not want that.
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
302 However, we receive bug reports because of this. To reduce time spent with
9457
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
303 solving these problems, these potentially unsafe actions are logged in
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
304 the savegame (including crash.sav). Log is stored in crash logs, too.
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
305
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
306 Information logged:
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
307
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
308 * Adding / removing / changing order of NewGRFs
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
309 * Changing NewGRF parameters, loading compatible NewGRF
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
310 * Changing game mode (scenario editor <-> normal game)
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
311 * Loading game saved in a different OpenTTD / TTDPatch / TTD version
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
312 * Running a modified OpenTTD build
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
313 * Changing settings affecting NewGRF behaviour (non-network-safe settings)
9457
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
314 * Changing landscape (by cheat)
9704
e1476334067a (svn r13816) -Fix [FS#2150]: check for vehicle length changes outside a depot (callback 0x11) and give a warning about that
smatz <smatz@openttd.org>
parents: 9558
diff changeset
315 * Triggering NewGRF bugs
9457
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
316
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
317 No personal information is stored.
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
318
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
319 You can show the game log by typing 'gamelog' in the console or by running
9457
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
320 OpenTTD in debug mode.
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
321
267a95510fdf (svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents: 8672
diff changeset
322
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
323 6.0) Configuration File:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
324 ---- -------------------
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
325 The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
326 .INI format. It's mostly undocumented. Almost all settings can be changed
11069
36d798171bfd (svn r15410) -Cleanup: get rid of most of the references to the 'patches' except where it's used for backward compatability.
rubidium <rubidium@openttd.org>
parents: 10583
diff changeset
327 ingame by using the 'Advanced Settings' window.
11372
371d9d118d1d (svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents: 11369
diff changeset
328 When you can not find openttd.cfg you should look in the directories as
371d9d118d1d (svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents: 11369
diff changeset
329 described in section 4.2. If you do not have an openttd.cfg OpenTTD will
371d9d118d1d (svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents: 11369
diff changeset
330 create one after closing.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
331
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
332
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
333 7.0) Compiling:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
334 ---- ----------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
335 Windows:
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
336 You need Microsoft Visual Studio .NET. Open the project file
1703
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
337 and it should build automatically. In case you want to build with SDL support
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
338 you need to add WITH_SDL to the project settings.
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
339 PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
340 to work you need their development files. For best results, download the
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
341 openttd-useful.zip file from http://www.openttd.org/download-openttd-useful
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
342 Put the header files into your compiler's include/ directory and the
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
343 library (.lib) files into the lib/ directory.
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
344 For more help with VS see docs/Readme_Windows_MSVC.txt.
222
d1b097f4593b (svn r223) -Fix: Const correctness and miscellaneous fixes. Thank you Tron for your diligent fixing of warnings (and some possibly bugs) (Tron)
darkvater <darkvater@openttd.org>
parents: 37
diff changeset
345
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
346 You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
347 Please read the Makefile for more information.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
348
12587
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
349 Solaris, FreeBSD, OpenBSD:
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
350 Use "gmake", but do a "./configure" before the first build.
6219
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
351
12587
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
352 Linux/Unix:
1133
1f932de27169 (svn r1634) Update readme: JAM support has been removed, also be more precise which version of SDL is needed to compile
tron <tron@openttd.org>
parents: 1125
diff changeset
353 OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake".
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
354 However, for the first build one has to do a "./configure" first.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
355
2937
181d8b11070e (svn r3493) -docs: [OSX] forgot to add Cocoa drivers and universal binaries as supported (thanks to Tobin for noticing)
bjarni <bjarni@openttd.org>
parents: 2936
diff changeset
356 MacOS X:
181d8b11070e (svn r3493) -docs: [OSX] forgot to add Cocoa drivers and universal binaries as supported (thanks to Tobin for noticing)
bjarni <bjarni@openttd.org>
parents: 2936
diff changeset
357 Use "make" or Xcode (which will then call make for you)
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
358 This will give you a binary for your CPU type (PPC/Intel)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
359 However, for the first build one has to do a "./configure" first.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
360 To make a universal binary type "./configure --enabled-universal"
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
361 instead of "./configure".
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
362
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
363 BeOS:
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
364 Use "make", but do a "./configure" before the first build.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
365
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
366 MorphOS:
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
367 Use "make". However, for the first build one has to do a "./configure" first.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
368 Note that you need the MorphOS SDK, latest libnix updates (else C++ parts of
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
369 OpenTTD will not build) and the powersdl.library SDK. Optionally libz,
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
370 libpng and freetype2 developer files.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
371
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
372 OS/2:
7045
49110cf8e2d9 (svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge <orudge@openttd.org>
parents: 6744
diff changeset
373 A comprehensive GNU build environment is required to build the OS/2 version.
49110cf8e2d9 (svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge <orudge@openttd.org>
parents: 6744
diff changeset
374 See the docs/Readme_OS2.txt file for more information.
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
375
10385
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
376 DOS:
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
377 A build environment with DJGPP is needed as well as libraries such as
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
378 Allegro, zlib and libpng, which all can be downloaded from the DJGPP
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
379 website. Compilation is straight forward: use make, but do a "./configure"
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
380 before the first build. The build binary will need cwsdpmi.exe to be in
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
381 the same directory as the openttd executable. cwsdpmi.exe can be found in
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
382 the os/dos subdirectory. If you compile with stripping turned on a binary
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
383 will be generated that does not need cwsdpmi.exe by adding the cswdstub.exe
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
384 to the created OpenTTD binary.
9709c41adf56 (svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents: 9945
diff changeset
385
12587
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
386 7.1) Required/optional libraries:
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
387 ---- -------------------
10453
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
388 The following libraries are used by OpenTTD for:
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
389 - libSDL/liballegro: hardware access (video, sound, mouse)
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
390 - zlib: (de)compressing of savegames
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
391 - libpng: making screenshots and loading heightmaps
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
392 - libfreetype: loading generic fonts and rendering them
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
393 - libfontconfig: searching for fonts, resolving font names to actual fonts
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
394 - libicu: handling of right-to-left scripts (e.g. Arabic and Persian)
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
395
12587
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
396 OpenTTD does not require any of the libraries to be present, but without
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
397 zlib you cannot open most savegames or use the content downloading system.
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
398 Without libSDL/liballegro on non-Windows and non-MacOS X machines you have
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
399 no graphical user interface; you would be building a dedicated server.
4b825b4a26a6 (svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents: 12283
diff changeset
400
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
401 8.0) Translating:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
402 ---- -------------------
10453
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
403 See http://www.openttd.org/development for up-to-date information.
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
404
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
405 The use of the online Translator service, located at
12283
37add2925080 (svn r16698) -Document: update documentation pointing to the old translator tool.
rubidium <rubidium@openttd.org>
parents: 12125
diff changeset
406 http://translator.openttd.org/, is highly encouraged. For getting an account
37add2925080 (svn r16698) -Document: update documentation pointing to the old translator tool.
rubidium <rubidium@openttd.org>
parents: 12125
diff changeset
407 simply follow the guidelines in the FAQ of the translator website.
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
408
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
409 If for some reason the website is down for a longer period of time, the
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
410 information below might be of help.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
411
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
412 8.1) Guidelines:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
413 ---- -------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
414 Here are some translation guidelines which you should follow closely.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
415
3122
ccf65121c0c0 (svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents: 2946
diff changeset
416 * Please contact the development team before beginning the translation
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
417 process! This avoids double work, as someone else may have already
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
418 started translating to the same language.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
419
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
420 8.2) Translation:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
421 ---- -------------------
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
422 So, now that you've notified the development team about your intention to
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
423 translate (You did, right? Of course you did.) you can pick up english.txt
10453
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
424 (found in the SVN repository under /src/lang) and translate.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
425
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
426 You must change the first two lines of the file appropriately:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
427
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
428 ##name English-Name-Of-Language
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
429 ##ownname Native-Name-Of-Language
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
430
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
431 Note: Do not alter the following parts of the file:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
432
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
433 * String identifiers (the first word on each line)
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
434 * Parts of the strings which are in curly braces (such as {STRING})
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
435 * Lines beginning with ## (such as ##id), other than the first two lines of
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
436 the file
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
437
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
438 8.3) Previewing:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
439 ---- -------------------
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
440 In order to view the translation in the game, you need to compile your language
10583
119424494408 (svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents: 10515
diff changeset
441 file with the strgen utility. You can download the precompiled strgen from:
119424494408 (svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents: 10515
diff changeset
442 http://www.openttd.org/download-strgen
119424494408 (svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents: 10515
diff changeset
443 To compile it yourself just take the normal OpenTTD sources and build that.
119424494408 (svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents: 10515
diff changeset
444 During the build process the strgen utility will be made.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
445
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
446 strgen is a command-line utility. It takes the language filename as parameter.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
447 Example:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
448
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
449 strgen lang/german.txt
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
450
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
451 This results in compiling german.txt and produces another file named german.lng.
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
452 Any missing strings are replaced with the English strings. Note that it looks
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
453 for english.txt in the lang subdirectory, which is where your language file
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
454 should also be.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
455
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
456 That's all! You should now be able to select the language in the game options.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
457
1703
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
458 9.0) Troubleshooting
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
459 ---- ---------------
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
460
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
461 To see all startup options available to you, start OpenTTD with the
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
462 "./openttd -h" option. This might help you tweak some of the settings.
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
463
3122
ccf65121c0c0 (svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents: 2946
diff changeset
464 If the game is acting strange and you feel adventurous you can try the
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
465 "-d [[<name>]=[<level>]" flag, where the higher levels will give you more
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
466 debugging output. The "name" variable can help you to display only some type of
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
467 debugging messages. This is mostly undocumented so best is to look in the
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
468 source code file debug.c for the various debugging types. For more information
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
469 look at http://wiki.openttd.org/index.php/Command_line.
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
470
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
471 The most frequent problem is missing data files. Don't forget to put all GRF
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
472 files from TTD into your data/ folder including sample.cat!
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
473
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
474 Under Windows 98 and lower it is impossible to use a dedicated server; it will
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
475 fail to start. Perhaps this is for the better because those OSes are not known
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
476 for their stability.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
477
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
478 With the added support for font-based text selecting a non-latin language will
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
479 result in garbage (lots of '?') shown on screen. Please open your configuration
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
480 file and add a desired font for small/medium/-and large_font. This can be a font
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
481 name like "Tahoma" or a path to a font.
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
482
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
483 Any NewGRF file used in a game is stored inside the savegame and will refuse
13453
ab95ef079c82 (svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents: 13172
diff changeset
484 to load if you don't have that NewGRF file available. A list of missing files
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
485 will be output to the console at the moment, so use the '-d' flag (on windows)
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
486 to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/)
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
487 put them in the data/ folder and you're set to go.
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
488
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
489 X.X) Credits:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
490 ---- --------
1124
405b7f9410be (svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents: 961
diff changeset
491 The OpenTTD team (in alphabetical order):
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
492 Jean-Francois Claeys (Belugas) - GUI, newindustries and more
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
493 Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
494 Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework
9945
538705a4c605 (svn r14100) -Fix(r14099): Who reads readme.txt files anyway?. Same work as previous commit.
belugas <belugas@openttd.org>
parents: 9704
diff changeset
495 Victor Fischer (Celestar) - Programming everywhere you need him to
538705a4c605 (svn r14100) -Fix(r14099): Who reads readme.txt files anyway?. Same work as previous commit.
belugas <belugas@openttd.org>
parents: 9704
diff changeset
496 Christoph Elsenhans (frosch) - General coding
11369
41fcb66a1256 (svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents: 11311
diff changeset
497 Loïc Guilloux (glx) - Windows Expert
10453
645c83f6f00c (svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents: 10399
diff changeset
498 Michael Lutz (michi_cc) - Path based signals
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
499 Owen Rudge (orudge) - Forum host, OS/2 port
8184
060e78474842 (svn r11747) -Change: Return of the prodigal son (or something). Little update (but highly noticed) on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8059
diff changeset
500 Peter Nelson (peter1138) - Spiritual descendant from newGRF gods
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
501 Remko Bijker (Rubidium) - Lead coder and way more
13063
d6196415e66a (svn r17561) -Fix: diacritics was missing at few places
smatz <smatz@openttd.org>
parents: 13058
diff changeset
502 Zdeněk Sojka (SmatZ) - Bug finder and fixer
11369
41fcb66a1256 (svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents: 11311
diff changeset
503 Thijs Marinussen (Yexo) - AI Framework
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
504
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
505 Inactive Developers:
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
506 Tamás Faragó (Darkvater) - Ex-Lead coder
11369
41fcb66a1256 (svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents: 11311
diff changeset
507 Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;)
41fcb66a1256 (svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents: 11311
diff changeset
508 Jonathan Coome (Maedhros) - High priest of the NewGRF Temple
12744
354ab0f30d7b (svn r17210) -Update: credits to reflect the (current) truth a bit better
rubidium <rubidium@openttd.org>
parents: 12716
diff changeset
509 Attila Bán (MiHaMiX) - WebTranslator 1 and 2
1125
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
510 Christoph Mallon (Tron) - Programmer, code correctness police
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
511
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
512 Retired Developers:
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
513 Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3)
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
514 Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3)
1703
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
515 Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6)
11369
41fcb66a1256 (svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents: 11311
diff changeset
516 Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker
12744
354ab0f30d7b (svn r17210) -Update: credits to reflect the (current) truth a bit better
rubidium <rubidium@openttd.org>
parents: 12716
diff changeset
517 Patric Stout (TrueLight) - Programmer (0.3 - pre0.7), sys op (active)
799
ca9bb7e58029 (svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents: 614
diff changeset
518
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
519 Thanks to:
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
520 Josef Drexler - For his great work on TTDPatch.
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
521 Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations)
13063
d6196415e66a (svn r17561) -Fix: diacritics was missing at few places
smatz <smatz@openttd.org>
parents: 13058
diff changeset
522 Petr Baudiš (pasky) - Many patches, newgrf support, etc.
8059
3cb0afbc2249 (svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents: 8052
diff changeset
523 Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
524 Stefan Meißner (sign_de) - For his work on the console
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
525 Mike Ragsdale - OpenTTD installer
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
526 Cian Duffy (MYOB) - BeOS port / manual writing
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
527 Christian Rosentreter (tokai) - MorphOS / AmigaOS port
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
528 Richard Kempton (RichK67) - Additional airports, initial TGP implementation
11225
b99d60de9a5d (svn r15578) -Change: unexternalise squirrel.
rubidium <rubidium@openttd.org>
parents: 11154
diff changeset
529 Alberto Demichelis - Squirrel scripting language
12744
354ab0f30d7b (svn r17210) -Update: credits to reflect the (current) truth a bit better
rubidium <rubidium@openttd.org>
parents: 12716
diff changeset
530 Markus F.X.J. Oberhumer - MiniLZO for loading old savegames
12777
5732e685a232 (svn r17247) -Change: move '3rd party' MD5 implementation also to the 3rdparty directory.
rubidium <rubidium@openttd.org>
parents: 12744
diff changeset
531 L. Peter Deutsch - MD5 implementation
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
532 Michael Blunck - For revolutionizing TTD with awesome graphics
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
533 George - Canal graphics
6691
d2fb32d942f7 (svn r9923) -Add: support for Action 0 Road vehicles, property 1C, bit 0.
rubidium <rubidium@openttd.org>
parents: 6673
diff changeset
534 David Dallaston (Pikka) - Tram tracks
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
535 All Translators - For their support to make OpenTTD a truly international game
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
536 Bug Reporters - Thanks for all bug reports
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
537 Chris Sawyer - For an amazing game!