Mercurial > hg > openttd
annotate readme.txt @ 20681:eda0607222af draft
-Cleanup: Coding style.
| author | Michael Lutz <michi@icosahedron.de> |
|---|---|
| date | Sun, 28 Jul 2013 22:03:45 +0200 |
| parents | e5a808fa9401 |
| children |
| rev | line source |
|---|---|
|
20356
23b557c24f12
(svn r25311) -Merge: documentation updates from 1.3
rubidium <rubidium@openttd.org>
parents:
20326
diff
changeset
|
1 Last updated: 2013-06-01 |
|
23b557c24f12
(svn r25311) -Merge: documentation updates from 1.3
rubidium <rubidium@openttd.org>
parents:
20326
diff
changeset
|
2 Release version: 1.3.1 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
3 ------------------------------------------------------------------------ |
|
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 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
6 Table of contents |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
7 ----------------- |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
8 1.0) About |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
9 2.0) Contacting |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
10 * 2.1) Reporting bugs |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
11 * 2.2) Reporting desyncs |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
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 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
14 * 4.1) (Required) 3rd party files |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
15 * 4.2) OpenTTD directories |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
16 * 4.3) Portable installations (portable media) |
|
18811
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
17 * 4.4) Files in tar (archives) |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
18 5.0) OpenTTD features |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
19 * 5.1) Logging of potentially dangerous actions |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
20 6.0) Configuration file |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
21 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
|
22 * 7.1) Required/optional libraries |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
23 * 7.2) Supported compilers |
|
20265
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
24 * 7.3) Compilation of base sets |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
25 8.0) Translating |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
26 * 8.1) Translation |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
27 * 8.2) 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
|
28 9.0) Troubleshooting |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
29 X.X) Credits |
|
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 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
32 1.0) About |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
33 ---- ----- |
|
16281
54210eaf9967
(svn r20982) -Change: Don't refer to OpenTTD as a "clone" any more
orudge <orudge@openttd.org>
parents:
16279
diff
changeset
|
34 OpenTTD is a transport simulation game based upon the popular game Transport |
|
54210eaf9967
(svn r20982) -Change: Don't refer to OpenTTD as a "clone" any more
orudge <orudge@openttd.org>
parents:
16279
diff
changeset
|
35 Tycoon Deluxe, written by Chris Sawyer. It attempts to mimic the original |
|
54210eaf9967
(svn r20982) -Change: Don't refer to OpenTTD as a "clone" any more
orudge <orudge@openttd.org>
parents:
16279
diff
changeset
|
36 game as closely as possible while extending it with new features. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
37 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
38 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
|
39 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
|
40 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
41 |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
42 2.0) Contacting |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
43 ---- ---------- |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
44 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
|
45 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
|
46 on irc.oftc.net). |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
47 |
|
250
9995f44f61b7
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents:
222
diff
changeset
|
48 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
|
49 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
50 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
|
51 http://forum.openttd.org/ |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
52 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
53 2.1) Reporting bugs |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
54 ---- -------------- |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
55 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
|
56 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
|
57 like this readme. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
58 |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
59 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
|
60 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
|
61 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
|
62 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
|
63 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
|
64 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
|
65 |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
66 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
|
67 * 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
|
68 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
|
69 * 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
|
70 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
|
71 forum thread related to that patch pack. |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
72 * 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
|
73 in which you can reproduce the issue once loaded. It is very useful to give |
|
13632
26e73974b916
(svn r18156) -Add: crash screenshot, created from blitter buffer
smatz <smatz@openttd.org>
parents:
13587
diff
changeset
|
74 us the crash.dmp, crash.sav, crash.log and crash screenshot which are |
|
26e73974b916
(svn r18156) -Add: crash screenshot, created from blitter buffer
smatz <smatz@openttd.org>
parents:
13587
diff
changeset
|
75 created on crashes. |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
76 * 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
|
77 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
|
78 |
|
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
79 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
|
80 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
|
81 * 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
|
82 * Bug details, including instructions how to reproduce it |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
83 * Platform (Windows, Linux, FreeBSD, ...) and compiler (including version) if |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
84 you compiled OpenTTD yourself. |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
85 * The processor architecture of your OS (32 bits Windows, 64 bits Windows, |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
86 Linux on an ARM, Mac OS X on a PowerPC, ...) |
|
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
87 * 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
|
88 * 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
|
89 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
|
90 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
|
91 * 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
|
92 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
|
93 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
94 2.2) Reporting desyncs |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
95 ---- ----------------- |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
96 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
|
97 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
|
98 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
|
99 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
|
100 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
|
101 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
|
102 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
|
103 |
|
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 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
|
105 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
|
106 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
|
107 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
|
108 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
|
109 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
|
110 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
|
111 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
|
112 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
|
113 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
|
114 |
|
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 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
|
116 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
|
117 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
|
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 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
|
120 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
|
121 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
|
122 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
|
123 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
|
124 |
|
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 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
|
126 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
|
127 - 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
|
128 - 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
|
129 '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
|
130 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
|
131 - 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
|
132 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
|
133 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
|
134 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
|
135 - 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
|
136 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
|
137 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
|
138 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
|
139 - in case you use any NewGRFs you should attach the ones you used unless |
|
16599
eecd1e6a1436
(svn r21329) -Doc: some readme tweaks (part by avdg)
rubidium <rubidium@openttd.org>
parents:
16559
diff
changeset
|
140 we can easily find them ourselves via bananas or when they are in the |
|
eecd1e6a1436
(svn r21329) -Doc: some readme tweaks (part by avdg)
rubidium <rubidium@openttd.org>
parents:
16559
diff
changeset
|
141 #openttdcoop pack. |
|
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
|
142 |
|
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
|
143 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
|
144 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
|
145 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
|
146 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
147 |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
148 3.0) Supported platforms |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
149 ---- ------------------- |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
150 OpenTTD has been ported to several platforms and operating systems. It should |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
151 not be very difficult to port it to a new platform. The currently working |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
152 platforms are: |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
153 |
|
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
154 BeOS - SDL or Allegro |
|
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
155 DOS - Allegro |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
156 FreeBSD - SDL |
|
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
157 Linux - SDL or Allegro |
|
14186
7213f12941ea
(svn r18734) -Prepare: for 1.0.0-beta2
rubidium <rubidium@openttd.org>
parents:
14077
diff
changeset
|
158 MacOS X (universal) - Cocoa video and sound drivers |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
159 MorphOS - SDL |
|
6673
b42a1e412f8e
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents:
6514
diff
changeset
|
160 OpenBSD - SDL |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
161 OS/2 - SDL |
|
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
162 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
|
163 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
164 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
165 4.0) Installing and running OpenTTD |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
166 ---- ------------------------------ |
|
7686
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
167 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
|
168 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
|
169 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
|
170 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
|
171 |
|
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
|
172 OpenTTD looks in multiple locations to find the required data files (described |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
173 in section 4.2). Installing any 3rd party files into a 'shared' location has |
|
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
|
174 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
|
175 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
|
176 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
|
177 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
|
178 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
|
179 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
|
180 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
|
181 resides, simply have your config file in that location. But if you remove this |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
182 config file, savegames will still be in this directory (see notes in |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
183 section 4.2 'OpenTTD directories') |
|
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
|
184 |
|
13773
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
185 OpenTTD comes without AIs, so if you want to play with AIs you have to download |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
186 them. The easiest way is via the 'Check Online Content' button in the main menu. |
|
13773
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
187 You can select some AIs that you think are compatible with your playing style. |
|
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
188 Another way is manually downloading the AIs from the forum although then you |
|
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
189 need to make sure that you install all the required AI libraries too; they get |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
190 automatically selected (and downloaded) if you get the AIs via the 'Check |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
191 Online Content'. If you do not have an AI but have configured OpenTTD to start |
|
13773
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
192 an AI a message will be shown that the 'dummy' AI has been started. |
|
955e98a9a36e
(svn r18298) -Document: that the dummy AI message is because 'you' don't have an AI... and how to 'solve' the issue; way too many people are ignorant
rubidium <rubidium@openttd.org>
parents:
13632
diff
changeset
|
193 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
194 4.1) (Required) 3rd party files |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
195 ---- -------------------------- |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
196 Before you run OpenTTD, you need to put the game's data files into a baseset/ |
|
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
|
197 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
|
198 section. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
199 |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
200 For OpenTTD you need to acquire some third party data files. For this you have |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
201 the choice of using the original Transport Tycoon Deluxe data files or a set |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
202 of free data 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
|
203 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
204 Do NOT copy files included with OpenTTD into 'shared' directories (explained in |
|
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
|
205 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
|
206 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
|
207 |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
208 4.1.1) Free graphics and sound files |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
209 ------ ----------------------------- |
|
14849
dd5dce187c8a
(svn r19442) -Update: readme about openmsx and make it easier to find the pulseaudio-ubuntu-slowness bug in the readme/known-bugs
rubidium <rubidium@openttd.org>
parents:
14537
diff
changeset
|
210 The free data files, split into OpenGFX for graphics, OpenSFX for sounds and |
|
dd5dce187c8a
(svn r19442) -Update: readme about openmsx and make it easier to find the pulseaudio-ubuntu-slowness bug in the readme/known-bugs
rubidium <rubidium@openttd.org>
parents:
14537
diff
changeset
|
211 OpenMSX for music can be found at: |
|
16279
62bf34fac6e7
(svn r20980) -Change: some tweaking of the readme about grfcodec/nforenum and linking to a more clear opengfx/opensfx/openmsx download page
rubidium <rubidium@openttd.org>
parents:
16240
diff
changeset
|
212 - http://www.openttd.org/download-opengfx for OpenGFX |
|
62bf34fac6e7
(svn r20980) -Change: some tweaking of the readme about grfcodec/nforenum and linking to a more clear opengfx/opensfx/openmsx download page
rubidium <rubidium@openttd.org>
parents:
16240
diff
changeset
|
213 - http://www.openttd.org/download-opensfx for OpenSFX |
|
62bf34fac6e7
(svn r20980) -Change: some tweaking of the readme about grfcodec/nforenum and linking to a more clear opengfx/opensfx/openmsx download page
rubidium <rubidium@openttd.org>
parents:
16240
diff
changeset
|
214 - http://www.openttd.org/download-openmsx for OpenMSX |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
215 Please follow the readme of these packages about the installation procedure. |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
216 The Windows installer can optionally download and install these packages. |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
217 |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
218 4.1.2) Original Transport Tycoon Deluxe graphics and sound files |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
219 ------ --------------------------------------------------------- |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
220 If you want to play with the original Transport Tycoon Deluxe data files you |
|
20326
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
221 have to copy the data files from the CD-ROM into the baseset/ directory. It |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
222 does not matter whether you copy them from the DOS or Windows version of |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
223 Transport Tycoon Deluxe. The Windows install can optionally copy these files. |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
224 You need to copy the following files: |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
225 - sample.cat |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
226 - trg1r.grf or TRG1.GRF |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
227 - trgcr.grf or TRGC.GRF |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
228 - trghr.grf or TRGH.GRF |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
229 - trgir.grf or TRGI.GRF |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
230 - trgtr.grf or TRGT.GRF |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
231 |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
232 4.1.3) Original Transport Tycoon Deluxe music |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
233 ------ -------------------------------------- |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
234 If you want the Transport Tycoon Deluxe music, copy the files from the gm/ |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
235 folder from the Windows version of Transport Tycoon Deluxe to the baseset |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
236 folder in your OpenTTD folder (also explained in the following sections). |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
237 The music from the DOS version as well as the original Transport Tycoon does |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
238 not work. |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
239 |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
240 4.1.4) AIs |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
241 ------ --- |
|
12827
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
242 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
|
243 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
|
244 download system download the tar file and place it in the ai/ directory. If the |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
245 AI needs libraries you will have to download those too and put them in the |
|
12827
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
246 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
|
247 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
|
248 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
|
249 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
|
250 itself. |
|
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
251 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
|
252 wait for an error message to pop up. The error message will tell you |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
253 'could not find library "lib-name"'. Download that library and try again. |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
254 |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
255 4.1.5) Game scripts |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
256 ------ ------------ |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
257 If you want an extra challenge in OpenTTD you can download so-called game |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
258 scripts via the in-game content downloader. These game scripts have varying |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
259 functionality, though they can generally influence town growth, subsidies, add |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
260 goals to reach or provide a different ranking system. |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
261 If you download a game script manually you have to follow the same rules as for |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
262 AIs, except that game scripts are placed in the game/ directory instead of the |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
263 ai/ directory. |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
264 |
|
12716
6f69fdced010
(svn r17179) -Merge: changelog etc. changes from 0.7 branch
rubidium <rubidium@openttd.org>
parents:
12587
diff
changeset
|
265 |
|
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
|
266 4.2) OpenTTD directories |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
267 ---- ------------------- |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
268 OpenTTD uses its own directory to store its required 3rd party base set files |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
269 (see section 4.1 'Required 3rd party files') and non-compulsory extension and |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
270 configuration files. See below for their proper place within this OpenTTD main |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
271 data directory. |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
272 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
273 The main OpenTTD directories can be found in various locations, depending on |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
274 your operating system: |
|
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
|
275 1. The current working directory (from where you started OpenTTD) |
|
15513
c4bd37c3a0c5
(svn r20166) -Fix [FS#3949]: do not scan /data and ~/data (if they happen to be your working directory). If it's the directory where your binary is located it will still scan them.
rubidium <rubidium@openttd.org>
parents:
15507
diff
changeset
|
276 For non-Windows operating systems OpenTTD will not scan for files in this |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
277 directory if it is your personal directory, i.e. '~/', or when it is the |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
278 root directory, i.e. '/'. |
|
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
|
279 2. Your personal directory |
|
18924
18b3430b6c5b
(svn r23774) -Fix: Wrong path in readme.txt
frosch <frosch@openttd.org>
parents:
18917
diff
changeset
|
280 Windows: C:\My Documents\OpenTTD (95, 98, ME) |
|
14348
6b52aeb513c9
(svn r18903) -Fix [FS#3562]: file locations for Windows weren't correct for all versions of Windows
rubidium <rubidium@openttd.org>
parents:
14318
diff
changeset
|
281 C:\Documents and Settings\<username>\My Documents\OpenTTD (2000, XP) |
|
6b52aeb513c9
(svn r18903) -Fix [FS#3562]: file locations for Windows weren't correct for all versions of Windows
rubidium <rubidium@openttd.org>
parents:
14318
diff
changeset
|
282 C:\Users\<username>\Documents\OpenTTD (Vista, 7) |
|
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
|
283 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
|
284 Linux: ~/.openttd |
|
13172
1bc00da70d10
(svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents:
13063
diff
changeset
|
285 3. The shared directory |
|
14348
6b52aeb513c9
(svn r18903) -Fix [FS#3562]: file locations for Windows weren't correct for all versions of Windows
rubidium <rubidium@openttd.org>
parents:
14318
diff
changeset
|
286 Windows: C:\Documents and Settings\All Users\Shared Documents\OpenTTD (2000, XP) |
|
6b52aeb513c9
(svn r18903) -Fix [FS#3562]: file locations for Windows weren't correct for all versions of Windows
rubidium <rubidium@openttd.org>
parents:
14318
diff
changeset
|
287 C:\Users\Public\Documents\OpenTTD (Vista, 7) |
|
13172
1bc00da70d10
(svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents:
13063
diff
changeset
|
288 Mac OSX: /Library/Application Support/OpenTTD |
|
1bc00da70d10
(svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents:
13063
diff
changeset
|
289 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
|
290 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
|
291 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
|
292 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
|
293 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
|
294 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
|
295 6. The application bundle (Mac OSX only) |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
296 It includes the OpenTTD files (grf+lng) and it will work as long as they |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
297 are not touched |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
298 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
299 Different types of data or extensions go into different subdirectories of the |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
300 chosen main OpenTTD directory: |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
301 Config File: (no subdirectory) |
|
19871
723a91a42f5c
(svn r24804) -Add: Separate subdirectory for screenshots.
frosch <frosch@openttd.org>
parents:
19725
diff
changeset
|
302 Screenshots: screenshot |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
303 Base Graphics: baseset (or a subdirectory thereof) |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
304 Sound Sets: baseset (or a subdirectory thereof) |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
305 NewGRFs: newgrf (or a subdirectory thereof) |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
306 32bpp Sets: newgrf (or a subdirectory thereof) |
|
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
307 Music Sets: baseset (or a subdirectory thereof) |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
308 AIs: ai (or a subdirectory thereof) |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
309 AI Libraries: ai/libraries (or a subdirectory thereof) |
|
18838
2ec03d6f7fa6
(svn r23687) -Fix [FS#4922]: document where the game script directory is
rubidium <rubidium@openttd.org>
parents:
18818
diff
changeset
|
310 Game Scripts (GS): game (or a subdirectory thereof) |
|
2ec03d6f7fa6
(svn r23687) -Fix [FS#4922]: document where the game script directory is
rubidium <rubidium@openttd.org>
parents:
18818
diff
changeset
|
311 GS Libraries: game/libraries (or a subdirectory thereof) |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
312 Savegames: save |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
313 Automatic Savegames: save/autosave |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
314 Scenarios: scenario |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
315 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
316 The (automatically created) directory content_download is for OpenTTD's internal |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
317 use and no files should be added to it or its subdirectories manually. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
318 |
|
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
|
319 Notes: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
320 - Linux in the previous list means .deb, but most paths should be similar for |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
321 others. |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
322 - The previous search order is also used for NewGRFs and openttd.cfg. |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
323 - If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
324 5 order. |
|
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
|
325 - 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
|
326 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
|
327 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
|
328 |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
329 The preferred setup: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
330 Place 3rd party files in shared directory (or in personal directory if you do |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
331 not have write access on shared directory) and have your openttd.cfg config |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
332 file in personal directory (where the game will then also place savegames and |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
333 screenshots). |
|
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
|
334 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
335 4.3) Portable installations (portable media) |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
336 ---- --------------------------------------- |
|
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
|
337 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
|
338 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
|
339 Create a directory where you shall store the game in (i.e. OpenTTD/). |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
340 Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), baseset/ and your |
|
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
|
341 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
|
342 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
|
343 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
|
344 media to. |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
345 As always - additional grf files are stored in the newgrf/ dir (for details, |
|
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
|
346 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
|
347 |
|
18811
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
348 4.4) Files in tar (archives) |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
349 ---- ----------------------- |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
350 OpenTTD can read files that are in an uncompressed tar (archive), which |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
351 makes it easy to bundle files belonging to the same script, NewGRF or base |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
352 set. Music sets are the only exception as they cannot be stored in a tar |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
353 file due to being played by external applications. |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
354 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
355 OpenTTD sees each tar archive as the 'root' of its search path. This means that |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
356 having a file with the same path in two different tar files means that one |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
357 cannot be opened, after all only one file will be found first. As such it is |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
358 advisable to put an uniquely named folder in the root of the tar and put all the |
|
18811
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
359 content in that folder. For example, all downloaded content has a path that |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
360 concatenates the name of the content and the version, which makes the path |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
361 unique. For custom tar files it is advised to do this as well. |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
362 |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
363 The normal files are also referred to by their relative path from the search |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
364 directory, this means that also normal files could hide files in a tar as |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
365 long as the relative path from the search path of the normal file is the |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
366 same as the path in the tar file. Again it is advised to have an unique path |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
367 to the normal file so they do not collide with the files from other tar |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
368 files. |
|
a8d5ee31e85b
(svn r23659) -Doc: behaviour of file searching in general, and in tars specifically
rubidium <rubidium@openttd.org>
parents:
18589
diff
changeset
|
369 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
370 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
371 5.0) OpenTTD features |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
372 ---- ---------------- |
|
15507
51133967fa9a
(svn r20159) -Change: clarify use of OpenTTD directories and don't use the "TTD" abbreviation for Transport Tycoon Deluxe (parts by planetmaker)
rubidium <rubidium@openttd.org>
parents:
14929
diff
changeset
|
373 OpenTTD has a lot of features going beyond the original Transport Tycoon Deluxe |
|
51133967fa9a
(svn r20159) -Change: clarify use of OpenTTD directories and don't use the "TTD" abbreviation for Transport Tycoon Deluxe (parts by planetmaker)
rubidium <rubidium@openttd.org>
parents:
14929
diff
changeset
|
374 emulation. Unfortunately, there is currently no comprehensive list of features, |
|
51133967fa9a
(svn r20159) -Change: clarify use of OpenTTD directories and don't use the "TTD" abbreviation for Transport Tycoon Deluxe (parts by planetmaker)
rubidium <rubidium@openttd.org>
parents:
14929
diff
changeset
|
375 but there 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
|
376 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
|
377 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
|
378 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
379 Several important non-standard controls: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
380 |
|
16240
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
381 * Ctrl modifies many commands and makes them more powerful. For example Ctrl |
|
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
382 clicking on signals with the build signal tool changes their behaviour, holding |
|
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
383 Ctrl while the track build tool is activated changes it to the track removal |
|
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
384 tool, and so on. See http://wiki.openttd.org/Hidden_features for a non- |
|
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
385 comprehensive list or look at the tooltips. |
|
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
|
386 * 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
|
387 http://wiki.openttd.org/index.php/Console |
|
16240
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
388 * Hovering over a GUI element shows tooltips. This can be changed to right click |
|
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
389 via the advanced settings. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
390 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
391 5.1) Logging of potentially dangerous actions |
|
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
|
392 ---- ---------------------------------------- |
|
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
|
393 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
|
394 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
|
395 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
|
396 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
|
397 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
|
398 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
|
399 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
|
400 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
|
401 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
|
402 |
|
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
|
403 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
|
404 |
|
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
|
405 * 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
|
406 * 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
|
407 * Changing game mode (scenario editor <-> normal game) |
|
15507
51133967fa9a
(svn r20159) -Change: clarify use of OpenTTD directories and don't use the "TTD" abbreviation for Transport Tycoon Deluxe (parts by planetmaker)
rubidium <rubidium@openttd.org>
parents:
14929
diff
changeset
|
408 * Loading game saved in a different OpenTTD / TTDPatch / Transport Tycoon Deluxe / |
|
51133967fa9a
(svn r20159) -Change: clarify use of OpenTTD directories and don't use the "TTD" abbreviation for Transport Tycoon Deluxe (parts by planetmaker)
rubidium <rubidium@openttd.org>
parents:
14929
diff
changeset
|
409 original Transport Tycoon version |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
410 * Running a modified OpenTTD build |
|
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
411 * Changing settings affecting NewGRF behaviour (non-network-safe settings) |
|
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
|
412 * 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
|
413 |
|
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
|
414 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
|
415 |
|
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
416 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
|
417 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
|
418 |
|
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
|
419 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
420 6.0) Configuration file |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
421 ---- ------------------ |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
422 The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
423 .INI format. It is 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
|
424 ingame by using the 'Advanced Settings' window. |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
425 When you cannot find openttd.cfg you should look in the directories as |
|
11372
371d9d118d1d
(svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents:
11369
diff
changeset
|
426 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
|
427 create one after closing. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
428 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
429 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
430 7.0) Compiling |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
431 ---- --------- |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
432 Windows: |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
433 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
|
434 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
|
435 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
|
436 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
|
437 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
|
438 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
|
439 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
|
440 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
|
441 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
|
442 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
443 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
|
444 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
|
445 |
|
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
|
446 Solaris, FreeBSD, OpenBSD: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
447 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
|
448 |
|
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
|
449 Linux/Unix: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
450 OpenTTD can be built with GNU 'make'. On non-GNU systems it is called 'gmake'. |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
451 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
|
452 |
|
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
|
453 MacOS X: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
454 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
|
455 This will give you a binary for your CPU type (PPC/Intel) |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
456 However, for the first build one has to do a './configure' first. |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
457 To make a universal binary type './configure --enabled-universal' |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
458 instead of './configure'. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
459 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
460 BeOS: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
461 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
|
462 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
463 MorphOS: |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
464 Use 'make'. However, for the first build one has to do a './configure' first. |
|
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
465 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
|
466 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
|
467 libpng and freetype2 developer files. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
468 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
469 OS/2: |
|
7045
49110cf8e2d9
(svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge <orudge@openttd.org>
parents:
6744
diff
changeset
|
470 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
|
471 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
|
472 |
|
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
473 DOS: |
|
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
474 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
|
475 Allegro, zlib and libpng, which all can be downloaded from the DJGPP |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
476 website. Compilation is straight forward: use make, but do a './configure' |
|
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
477 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
|
478 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
|
479 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
|
480 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
|
481 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
|
482 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
483 7.1) Required/optional libraries |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
484 ---- --------------------------- |
|
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
|
485 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
|
486 - libSDL/liballegro: hardware access (video, sound, mouse) |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
487 - zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
488 heightmaps |
|
14218
e6fc77426cbd
(svn r18769) -Codechange: replace MiniLZO with the real library. If you're using MSVC update openttd-useful, otherwise make sure you've got liblzo2 and it's development files installed.
rubidium <rubidium@openttd.org>
parents:
14186
diff
changeset
|
489 - liblzo2: (de)compressing of old (pre 0.3.0) savegames |
|
16336
d9ef22b55063
(svn r21044) -Feature: XZ/LZMA2 savegame support. New default reduces savegame size by 10 to 30% with slightly more CPU usage. With maximum settings it reduces savegame size by 20 to 30%, but that takes 7 to 14 times longer. Map saving + downloading takes, on average, 5% less.
rubidium <rubidium@openttd.org>
parents:
16281
diff
changeset
|
490 - liblzma: (de)compressing of savegames (1.1.0 and later) |
|
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
|
491 - 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
|
492 - 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
|
493 - libfontconfig: searching for fonts, resolving font names to actual fonts |
|
16613
4527392bba00
(svn r21343) -Add: Function that compares strings using case insensitive natural sort.
terkhen <terkhen@openttd.org>
parents:
16599
diff
changeset
|
494 - libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and |
|
4527392bba00
(svn r21343) -Add: Function that compares strings using case insensitive natural sort.
terkhen <terkhen@openttd.org>
parents:
16599
diff
changeset
|
495 natural sorting of strings. |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
496 |
|
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
|
497 OpenTTD does not require any of the libraries to be present, but without |
|
16336
d9ef22b55063
(svn r21044) -Feature: XZ/LZMA2 savegame support. New default reduces savegame size by 10 to 30% with slightly more CPU usage. With maximum settings it reduces savegame size by 20 to 30%, but that takes 7 to 14 times longer. Map saving + downloading takes, on average, 5% less.
rubidium <rubidium@openttd.org>
parents:
16281
diff
changeset
|
498 liblzma you cannot open most recent savegames and without zlib you cannot |
|
d9ef22b55063
(svn r21044) -Feature: XZ/LZMA2 savegame support. New default reduces savegame size by 10 to 30% with slightly more CPU usage. With maximum settings it reduces savegame size by 20 to 30%, but that takes 7 to 14 times longer. Map saving + downloading takes, on average, 5% less.
rubidium <rubidium@openttd.org>
parents:
16281
diff
changeset
|
499 open most older savegames or use the content downloading system. |
|
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
|
500 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
|
501 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
|
502 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
503 7.2) Supported compilers |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
504 ---- ------------------- |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
505 The following compilers are known to compile OpenTTD: |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
506 - Microsoft Visual C++ (MSVC) 2005, 2008 and 2010. |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
507 Version 2005 gives bogus warnings about scoping issues. |
|
20326
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
508 - GNU Compiler Collection (GCC) 3.3 - 4.4, 4.6 - 4.8. |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
509 Versions 4.1 and earlier give bogus warnings about uninitialised variables. |
|
20326
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
510 Versions 4.4, 4.6 give bogus warnings about freeing non-heap objects. |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
511 Versions 4.6 and later give invalid warnings when lto is enabled. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
512 - Intel C++ Compiler (ICC) 12.0. |
|
19087
6c68329f2cfb
(svn r23941) -Add: support for clang
smatz <smatz@openttd.org>
parents:
19049
diff
changeset
|
513 - Clang/LLVM 2.9 - 3.0 |
|
6c68329f2cfb
(svn r23941) -Add: support for clang
smatz <smatz@openttd.org>
parents:
19049
diff
changeset
|
514 Version 2.9 gives bogus warnings about code nonconformity. |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
515 |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
516 The following compilers are known not to compile OpenTTD: |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
517 - Microsoft Visual C++ (MSVC) 2003 and earlier. |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
518 - GNU Compiler Collection (GCC) 3.2 and earlier. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
519 These old versions fail due to OpenTTD's template usage. |
|
20326
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
520 - GNU Compiler Collection (GCC) 4.5. It optimizes enums too aggressively. |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
521 See http://bugs.openttd.org/task/5513 and references therein. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
522 - Intel C++ Compiler (ICC) 11.1 and earlier. |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
523 Version 10.0 and earlier fail a configure check and fail with recent system |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
524 headers. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
525 Version 10.1 fails to compile station_gui.cpp. |
|
19087
6c68329f2cfb
(svn r23941) -Add: support for clang
smatz <smatz@openttd.org>
parents:
19049
diff
changeset
|
526 Version 11.1 fails with an internal error when compiling network.cpp. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
527 - Clang/LLVM 2.8 and earlier. |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
528 - (Open) Watcom. |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
529 |
|
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
530 If any of these compilers can compile OpenTTD again, please let us know. |
|
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
531 Patches to support more compilers are welcome. |
|
14537
7d497b6dc9ea
(svn r19108) -Document: what compilers are known to succeed compiling OpenTTD and which ones have proven to fail compiling OpenTTD
rubidium <rubidium@openttd.org>
parents:
14450
diff
changeset
|
532 |
|
20265
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
533 7.3) Compilation of base sets |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
534 ----------------------------- |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
535 To recompile the extra graphics needed to play with the original Transport |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
536 Tycoon Deluxe graphics you need GRFCodec (which includes NFORenum) as well. |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
537 GRFCodec can be found at: http://www.openttd.org/download-grfcodec |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
538 The compilation of these extra graphics does generally not happen, unless |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
539 you remove the graphics file using 'make maintainer-clean'. |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
540 |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
541 Re-compilation of the base sets, thus also use of --maintainer-clean can |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
542 leave the repository in a modified state as different grfcodec versions can |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
543 cause binary differences in the resulting grf. Also translations might have |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
544 been added for the base sets which are not yet included in the base set |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
545 information files. Use the configure option --without-grfcodec to avoid |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
546 modification of the base set files by the build process. |
|
18b63ac2505f
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
planetmaker <planetmaker@openttd.org>
parents:
20183
diff
changeset
|
547 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
548 |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
549 8.0) Translating |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
550 ---- ----------- |
|
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
|
551 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
|
552 |
|
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
|
553 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
|
554 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
|
555 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
|
556 |
|
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
|
557 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
|
558 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
|
559 |
|
13947
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
560 Please contact the translations manager (http://www.openttd.org/contact) |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
561 before beginning the translation process! This avoids double work, as |
|
4f086751330d
(svn r18483) -Document [FS#3367]: that OpenGFX/OpenSFX can be used and where to find them. Also refer to the readme in some error messages.
rubidium <rubidium@openttd.org>
parents:
13828
diff
changeset
|
562 someone else may have already 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
|
563 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
564 8.1) Translation |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
565 ---- ----------- |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
566 So, now that you have notified the development team about your intention to |
|
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
|
567 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
|
568 (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
|
569 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
570 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
|
571 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
572 ##name English-Name-Of-Language |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
573 ##ownname Native-Name-Of-Language |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
574 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
575 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
|
576 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
577 * 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
|
578 * 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
|
579 * 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
|
580 the file |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
581 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
582 8.2) Previewing |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
583 ---- ---------- |
|
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
|
584 In order to view the translation in the game, you need to compile your language |
|
20326
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
585 file with the strgen utility. As this utility is tailored to a specific OpenTTD |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
586 version, you need to compile it yourself. Just take the normal OpenTTD sources |
|
4f7fcc52f1cd
(svn r25278) -Doc: Update some small parts of the readme
planetmaker <planetmaker@openttd.org>
parents:
20265
diff
changeset
|
587 and build that. 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
|
588 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
589 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
|
590 Example: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
591 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
592 strgen lang/german.txt |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
593 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
594 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
|
595 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
|
596 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
|
597 should also be. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
598 |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
599 That is all! You should now be able to select the language in the game options. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
600 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
601 |
|
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
|
602 9.0) Troubleshooting |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
603 ---- --------------- |
|
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
|
604 To see all startup options available to you, start OpenTTD with the |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
605 './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
|
606 |
|
3122
ccf65121c0c0
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents:
2946
diff
changeset
|
607 If the game is acting strange and you feel adventurous you can try the |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
608 '-d [[<name>=]<level>]' flag, where the higher levels will give you more |
|
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
609 debugging output. The 'name' variable can help you to display only some type of |
|
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
|
610 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
|
611 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
|
612 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
|
613 |
|
14849
dd5dce187c8a
(svn r19442) -Update: readme about openmsx and make it easier to find the pulseaudio-ubuntu-slowness bug in the readme/known-bugs
rubidium <rubidium@openttd.org>
parents:
14537
diff
changeset
|
614 The most frequent problem is missing data files. Please install OpenGFX and |
|
dd5dce187c8a
(svn r19442) -Update: readme about openmsx and make it easier to find the pulseaudio-ubuntu-slowness bug in the readme/known-bugs
rubidium <rubidium@openttd.org>
parents:
14537
diff
changeset
|
615 possibly OpenSFX and OpenMSX. See section 4.1.1 for more information. |
|
dd5dce187c8a
(svn r19442) -Update: readme about openmsx and make it easier to find the pulseaudio-ubuntu-slowness bug in the readme/known-bugs
rubidium <rubidium@openttd.org>
parents:
14537
diff
changeset
|
616 |
|
17340
ed1445ee6e5f
(svn r22080) -Doc: Add doxygen comments to a few functions and improve a few existing comments
planetmaker <planetmaker@openttd.org>
parents:
17228
diff
changeset
|
617 Under certain circumstance, especially on Ubuntu OpenTTD can be extremely slow |
|
ed1445ee6e5f
(svn r22080) -Doc: Add doxygen comments to a few functions and improve a few existing comments
planetmaker <planetmaker@openttd.org>
parents:
17228
diff
changeset
|
618 and/or freeze. See known-bugs.txt for more information and how to solve this |
|
ed1445ee6e5f
(svn r22080) -Doc: Add doxygen comments to a few functions and improve a few existing comments
planetmaker <planetmaker@openttd.org>
parents:
17228
diff
changeset
|
619 problem on your computer. |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
620 |
|
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
|
621 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
|
622 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
|
623 for their stability. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
624 |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
625 With the added support for font-based text selecting a non-latin language can |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
626 result in lots of question marks ('?') being shown on screen. Please open your |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
627 configuration file (openttd.cfg - see Section 4.2 for where to find it) |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
628 and add a suitable font for the small, medium and / or large font, e.g.: |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
629 small_font = "Tahoma" |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
630 medium_font = "Tahoma" |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
631 large_font = "Tahoma" |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
632 You should use a font name like 'Tahoma' or a path to the desired font. |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
633 |
|
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
634 Any NewGRF file used in a game is stored inside the savegame and will refuse |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
635 to load if you do not have that NewGRF file available. A list of missing files |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
636 can be viewed in the NewGRF window accessible from the file load dialogue window. |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
637 |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
638 You can try to obtain the missing files from that NewGRF dialogue or - if they |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
639 are not available online - you can search manually through our forum's graphics |
|
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
640 development section (http://www.tt-forums.net/viewforum.php?f=66) or GrfCrawler |
|
18385
eef754fea9b8
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
rubidium <rubidium@openttd.org>
parents:
18114
diff
changeset
|
641 (http://grfcrawler.tt-forums.net/). Put the NewGRF files in OpenTTD's newgrf folder |
|
19358
f47251014f59
(svn r24257) -Fix [FS#5112]: update some outdated documentation and make is somewhat more consistent
rubidium <rubidium@openttd.org>
parents:
19232
diff
changeset
|
642 (see section 4.2 'OpenTTD directories') and rescan the list of available NewGRFs. |
|
17697
a968e3a43dfd
(svn r22477) -Doc: Update readme with more extensive information on directories used, font configuration and how to deal with missing NewGRFs
planetmaker <planetmaker@openttd.org>
parents:
17520
diff
changeset
|
643 Once you have all missing files, you are set to go. |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
644 |
|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
645 |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
646 X.X) Credits |
|
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
647 ---- ------- |
|
1124
405b7f9410be
(svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents:
961
diff
changeset
|
648 The OpenTTD team (in alphabetical order): |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
649 Albert Hofkamp (Alberth) - GUI expert |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
650 Jean-François Claeys (Belugas) - GUI, newindustries and more |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
651 Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework |
|
20417
e5a808fa9401
(svn r25375) -Update: add fonsinchen to credits
fonsinchen <fonsinchen@openttd.org>
parents:
20356
diff
changeset
|
652 Ulf Hermann (fonsinchen) - Cargo Distribution |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
653 Christoph Elsenhans (frosch) - General coding |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
654 Loïc Guilloux (glx) - Windows Expert |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
655 Michael Lutz (michi_cc) - Path based signals |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
656 Owen Rudge (orudge) - Forum host, OS/2 port |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
657 Peter Nelson (peter1138) - Spiritual descendant from newGRF gods |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
658 Ingo von Borstel (planetmaker) - Support |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
659 Remko Bijker (Rubidium) - Lead coder and way more |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
660 Zdeněk Sojka (SmatZ) - Bug finder and fixer |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
661 José Soler (Terkhen) - General coding |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
662 Thijs Marinussen (Yexo) - AI Framework |
|
19585
09d1c19640c3
(svn r24494) -Update: Some documentation.
frosch <frosch@openttd.org>
parents:
19568
diff
changeset
|
663 Leif Linse (Zuu) - AI/Game Script |
|
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
|
664 |
|
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
|
665 Inactive Developers: |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
666 Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
667 Victor Fischer (Celestar) - Programming everywhere you need him to |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
668 Tamás Faragó (Darkvater) - Ex-Lead coder |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
669 Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
670 Jonathan Coome (Maedhros) - High priest of the NewGRF Temple |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
671 Attila Bán (MiHaMiX) - WebTranslator 1 and 2 |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
672 Christoph Mallon (Tron) - Programmer, code correctness police |
|
1125
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
673 |
|
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
674 Retired Developers: |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
675 Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
676 Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
677 Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
678 Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker |
|
19049
7d0013f2fd5d
(svn r23903) -Fix [FS#4993]: some instances had issues due to a value being out of range
rubidium <rubidium@openttd.org>
parents:
19022
diff
changeset
|
679 Patric Stout (TrueBrain) - NoProgrammer (0.3 - 1.2), 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
|
680 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
681 Thanks to: |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
682 Josef Drexler - For his great work on TTDPatch. |
|
20028
6ca19142dc9f
(svn r24960) -Fix [FS#5423]: inconsistencies in the "thanks to" lists
rubidium <rubidium@openttd.org>
parents:
19917
diff
changeset
|
683 Marcin Grzegorczyk - For his TTDPatch work and documentation of Transport Tycoon Deluxe internals and track foundations |
|
17957
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
684 Petr Baudiš (pasky) - Many patches, newgrf support, etc. |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
685 Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
686 Stefan Meißner (sign_de) - For his work on the console |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
687 Mike Ragsdale - OpenTTD installer |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
688 Cian Duffy (MYOB) - BeOS port / manual writing |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
689 Christian Rosentreter (tokai) - MorphOS / AmigaOS port |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
690 Richard Kempton (RichK67) - Additional airports, initial TGP implementation |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
691 Alberto Demichelis - Squirrel scripting language |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
692 L. Peter Deutsch - MD5 implementation |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
693 Michael Blunck - For revolutionizing TTD with awesome graphics |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
694 George - Canal graphics |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
695 Andrew Parkhouse (andythenorth) - River graphics |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
696 David Dallaston (Pikka) - Tram tracks |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
697 All Translators - For their support to make OpenTTD a truly international game |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
698 Bug Reporters - Thanks for all bug reports |
|
9edeba50484f
(svn r22766) -Add: river graphics for the original base set (andythenorth)
rubidium <rubidium@openttd.org>
parents:
17943
diff
changeset
|
699 Chris Sawyer - For an amazing game! |