Mercurial > hg > openttd
annotate readme.txt @ 17232:5d82f4101601 draft
(svn r21972) -Fix: Replace 'None' industries in the generation window with more descriptive label.
author | alberth <alberth@openttd.org> |
---|---|
date | Sat, 05 Feb 2011 11:42:27 +0000 |
parents | 688b9bfbe6ae |
children | ed1445ee6e5f |
rev | line source |
---|---|
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
1 OpenTTD readme |
17228
688b9bfbe6ae
(svn r21967) -Prepare: for 1.1.0-beta5
rubidium <rubidium@openttd.org>
parents:
17135
diff
changeset
|
2 Last updated: 2011-02-04 |
688b9bfbe6ae
(svn r21967) -Prepare: for 1.1.0-beta5
rubidium <rubidium@openttd.org>
parents:
17135
diff
changeset
|
3 Release version: 1.1.0-beta5 |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
4 ------------------------------------------------------------------------ |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
5 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
6 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
7 Table of contents |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
8 ----------------- |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
9 1.0) About |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
10 2.0) Contacting |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
11 * 2.1) Reporting bugs |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
12 * 2.2) Reporting desyncs |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
13 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
|
14 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
|
15 * 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
|
16 * 4.2) OpenTTD directories |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
17 * 4.3) Portable installations (portable media) |
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 |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
24 8.0) Translating |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
25 * 8.1) Translation |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
26 * 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
|
27 9.0) Troubleshooting |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
28 X.X) Credits |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
29 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
30 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
31 1.0) About |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
32 ---- ----- |
16281
54210eaf9967
(svn r20982) -Change: Don't refer to OpenTTD as a "clone" any more
orudge <orudge@openttd.org>
parents:
16279
diff
changeset
|
33 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
|
34 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
|
35 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
|
36 |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
37 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
|
38 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
|
39 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
40 |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
41 2.0) Contacting |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
42 ---- ---------- |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
43 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
|
44 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
|
45 on irc.oftc.net). |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
46 |
250
9995f44f61b7
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents:
222
diff
changeset
|
47 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
|
48 |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
49 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
|
50 http://forum.openttd.org/ |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
51 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
52 2.1) Reporting bugs |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
53 ---- -------------- |
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
54 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
|
55 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
|
56 like this readme. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
57 |
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
58 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
|
59 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
|
60 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
|
61 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
|
62 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
|
63 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
|
64 |
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
65 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
|
66 * 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
|
67 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
|
68 * 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
|
69 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
|
70 forum thread related to that patch pack. |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
71 * 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
|
72 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
|
73 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
|
74 created on crashes. |
13056
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
75 * 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
|
76 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
|
77 |
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
78 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
|
79 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
|
80 * 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
|
81 * Bug details, including instructions how to reproduce it |
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
82 * Platform (Win32, Linux, FreeBSD, ...) and compiler (including version) if |
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
83 you compiled OpenTTD yourself. |
f512ef96e101
(svn r17554) -Update: documentation about bug reporting and known bugs
rubidium <rubidium@openttd.org>
parents:
12827
diff
changeset
|
84 * 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
|
85 * 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
|
86 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
|
87 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
|
88 * 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
|
89 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
|
90 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
91 2.2) Reporting desyncs |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
92 ---- ----------------- |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
93 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
|
94 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
|
95 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
|
96 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
|
97 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
|
98 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
|
99 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
|
100 |
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 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
|
102 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
|
103 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
|
104 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
|
105 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
|
106 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
|
107 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
|
108 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
|
109 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
|
110 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
|
111 |
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 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
|
113 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
|
114 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
|
115 |
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 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
|
117 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
|
118 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
|
119 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
|
120 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
|
121 |
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 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
|
123 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
|
124 - 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
|
125 - 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
|
126 '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
|
127 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
|
128 - 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
|
129 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
|
130 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
|
131 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
|
132 - 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
|
133 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
|
134 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
|
135 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
|
136 - 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
|
137 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
|
138 #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
|
139 |
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
|
140 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
|
141 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
|
142 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
|
143 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
144 |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
145 3.0) Supported platforms |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
146 ---- ------------------- |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
147 OpenTTD has been ported to several platforms and operating systems. It shouldn't |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
148 be very difficult to port it to a new platform. The currently working platforms |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
149 are: |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
150 |
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
151 BeOS - SDL or Allegro |
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
152 DOS - Allegro |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
153 FreeBSD - SDL |
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
154 Linux - SDL or Allegro |
14186
7213f12941ea
(svn r18734) -Prepare: for 1.0.0-beta2
rubidium <rubidium@openttd.org>
parents:
14077
diff
changeset
|
155 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
|
156 MorphOS - SDL |
6673
b42a1e412f8e
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents:
6514
diff
changeset
|
157 OpenBSD - SDL |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
158 OS/2 - SDL |
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
159 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
|
160 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
161 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
162 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
|
163 ---- ------------------------------ |
7686
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
164 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
|
165 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
|
166 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
|
167 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
|
168 |
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
|
169 OpenTTD looks in multiple locations to find the required data files (described |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
170 in section 4.2). Installing any 3rd party files into a "shared" location has |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
171 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
|
172 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
|
173 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
|
174 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
|
175 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
|
176 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
|
177 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
|
178 resides, simply have your config file in that location. But if you remove this |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
179 config file, savegames will still be in this directory (see notes in section 4.2) |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
180 |
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
|
181 OpenTTD comes without AIs, so if you want to play with AIs you have to download |
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
|
182 them. The easiest way is via the "Check Online Content" button in the main menu. |
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
|
183 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
|
184 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
|
185 need to make sure that you install all the required AI libraries too; they get |
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
|
186 automatically selected (and downloaded) if you get the AIs via the "Check |
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 Online Content". If you do not have an AI but have configured OpenTTD to start |
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 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
|
189 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
190 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
|
191 ---- -------------------------- |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
192 Before you run OpenTTD, you need to put the game's data files into a data/ |
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
193 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
|
194 section. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
195 |
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
|
196 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
|
197 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
|
198 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
|
199 |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
200 Do NOT copy files included with OpenTTD into "shared" directories (explained in |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
201 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
|
202 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
|
203 |
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
|
204 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
|
205 ------ ----------------------------- |
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
|
206 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
|
207 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
|
208 - 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
|
209 - 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
|
210 - 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
|
211 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
|
212 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
|
213 |
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
|
214 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
|
215 ------ --------------------------------------------------------- |
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 If you want to play with the original Transport Tycoon Deluxe data files you |
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 have to copy the data files from the CD-ROM into the data/ directory. It does |
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 not matter whether you copy them from the DOS or Windows version of Transport |
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 Tycoon Deluxe. The Windows install can optionally copy these 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
|
220 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
|
221 - 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
|
222 - 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
|
223 - 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
|
224 - 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
|
225 - 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
|
226 - 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
|
227 |
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 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
|
229 ------ -------------------------------------- |
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
|
230 If you want the Transport Tycoon Deluxe music, copy the gm/ folder from the |
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
|
231 Windows version of Transport Tycoon Deluxe to your OpenTTD folder (not your |
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
|
232 data folder - also explained in the following sections). The music from the |
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
|
233 DOS version as well as the original Transport Tycoon does 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
|
234 |
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
|
235 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
|
236 ------ --- |
12827
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
237 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
|
238 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
|
239 download system download the tar file and place it in the ai/ directory. If the |
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
240 AI needs libraries you'll have to download those too and put them in the |
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
241 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
|
242 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
|
243 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
|
244 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
|
245 itself. |
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
246 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
|
247 wait for an error message to pop up. The error message will tell you |
864793d914db
(svn r17317) -Document: how to manually install AIs
yexo <yexo@openttd.org>
parents:
12777
diff
changeset
|
248 "couldn't find library 'lib-name'". Download that library and try again. |
12716
6f69fdced010
(svn r17179) -Merge: changelog etc. changes from 0.7 branch
rubidium <rubidium@openttd.org>
parents:
12587
diff
changeset
|
249 |
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
|
250 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
|
251 ---- ------------------- |
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
|
252 The required 3rd party files listed in the section 4.1 "(Required) 3rd party files" |
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
|
253 as well as other non-compulsory extensions (NewGRFs, AI, heightmaps, scenarios) can be |
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
|
254 placed in a few different locations: |
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
255 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
|
256 For non-Windows operating systems OpenTTD will not scan for files in this |
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
|
257 directory if it is your personal directory, i.e. "~/", or when it is the |
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
|
258 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
|
259 2. Your personal 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
|
260 Windows: C:\My Documents (95, 98, ME) |
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
|
261 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
|
262 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
|
263 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
|
264 Linux: ~/.openttd |
13172
1bc00da70d10
(svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents:
13063
diff
changeset
|
265 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
|
266 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
|
267 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
|
268 Mac OSX: /Library/Application Support/OpenTTD |
1bc00da70d10
(svn r17679) -Merge: release changes back into trunk
rubidium <rubidium@openttd.org>
parents:
13063
diff
changeset
|
269 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
|
270 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
|
271 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
|
272 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
|
273 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
|
274 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
|
275 6. The application bundle (Mac OSX only) |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
276 It includes the OpenTTD files (grf+lng) and it will work as long as they aren't touched |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
277 |
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
|
278 Notes: |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
279 - Linux in the previous list means .deb, but most paths should be similar for others. |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
280 - The previous search order is also used for NewGRFs and openttd.cfg. |
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
281 - If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, 5 order. |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
282 - 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
|
283 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
|
284 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
|
285 |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
286 The preferred setup: |
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
287 Place 3rd party files in shared directory (or in personal directory if you don't |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
288 have write access on shared directory) and have your openttd.cfg config file in |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
289 personal directory (where the game will then also place savegames and screenshots). |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
290 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
291 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
|
292 ---- --------------------------------------- |
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
|
293 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
|
294 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
|
295 Create a directory where you shall store the game in (i.e. OpenTTD/). |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
296 Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), data/ and your |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
297 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
|
298 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
|
299 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
|
300 media to. |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
301 As always - additional grf files are stored in the data/ dir (for details, |
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
302 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
|
303 |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
304 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
305 5.0) OpenTTD features |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
306 ---- ---------------- |
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
|
307 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
|
308 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
|
309 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
|
310 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
|
311 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
|
312 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
313 Several important non-standard controls: |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
314 |
16240
739c4b9285f2
(svn r20941) -Fix [FS#4163]: Readme referred to outdated behaviour
planetmaker <planetmaker@openttd.org>
parents:
16239
diff
changeset
|
315 * 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
|
316 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
|
317 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
|
318 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
|
319 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
|
320 * 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
|
321 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
|
322 * 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
|
323 via the advanced settings. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
324 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
325 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
|
326 ---- ---------------------------------------- |
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
|
327 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
|
328 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
|
329 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
|
330 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
|
331 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
|
332 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
|
333 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
|
334 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
|
335 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
|
336 |
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
|
337 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
|
338 |
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
|
339 * 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
|
340 * 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
|
341 * 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
|
342 * 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
|
343 original Transport Tycoon version |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
344 * Running a modified OpenTTD build |
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
345 * Changing settings affecting NewGRF behaviour (non-network-safe settings) |
9457
267a95510fdf
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents:
8672
diff
changeset
|
346 * Changing landscape (by cheat) |
9704
e1476334067a
(svn r13816) -Fix [FS#2150]: check for vehicle length changes outside a depot (callback 0x11) and give a warning about that
smatz <smatz@openttd.org>
parents:
9558
diff
changeset
|
347 * 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
|
348 |
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
|
349 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
|
350 |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
351 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
|
352 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
|
353 |
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
|
354 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
355 6.0) Configuration file |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
356 ---- ------------------ |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
357 The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like |
2401
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
358 .INI format. It's mostly undocumented. Almost all settings can be changed |
11069
36d798171bfd
(svn r15410) -Cleanup: get rid of most of the references to the 'patches' except where it's used for backward compatability.
rubidium <rubidium@openttd.org>
parents:
10583
diff
changeset
|
359 ingame by using the 'Advanced Settings' window. |
11372
371d9d118d1d
(svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents:
11369
diff
changeset
|
360 When you can not find openttd.cfg you should look in the directories as |
371d9d118d1d
(svn r15722) -Change: add a bit more information to the readme.
rubidium <rubidium@openttd.org>
parents:
11369
diff
changeset
|
361 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
|
362 create one after closing. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
363 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
364 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
365 7.0) Compiling |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
366 ---- --------- |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
367 Windows: |
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
368 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
|
369 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
|
370 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
|
371 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
|
372 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
|
373 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
|
374 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
|
375 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
|
376 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
|
377 |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
378 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
|
379 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
|
380 |
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
|
381 Solaris, FreeBSD, OpenBSD: |
4b825b4a26a6
(svn r17027) -Document: that Solaris needs gmake instead of make and generalise the compiling section a bit
rubidium <rubidium@openttd.org>
parents:
12283
diff
changeset
|
382 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
|
383 |
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
|
384 Linux/Unix: |
1133
1f932de27169
(svn r1634) Update readme: JAM support has been removed, also be more precise which version of SDL is needed to compile
tron <tron@openttd.org>
parents:
1125
diff
changeset
|
385 OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake". |
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
386 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
|
387 |
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
|
388 MacOS X: |
181d8b11070e
(svn r3493) -docs: [OSX] forgot to add Cocoa drivers and universal binaries as supported (thanks to Tobin for noticing)
bjarni <bjarni@openttd.org>
parents:
2936
diff
changeset
|
389 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
|
390 This will give you a binary for your CPU type (PPC/Intel) |
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
391 However, for the first build one has to do a "./configure" first. |
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
392 To make a universal binary type "./configure --enabled-universal" |
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
393 instead of "./configure". |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
394 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
395 BeOS: |
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
396 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
|
397 |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
398 MorphOS: |
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
399 Use "make". However, for the first build one has to do a "./configure" first. |
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
400 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
|
401 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
|
402 libpng and freetype2 developer files. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
403 |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
404 OS/2: |
7045
49110cf8e2d9
(svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge <orudge@openttd.org>
parents:
6744
diff
changeset
|
405 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
|
406 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
|
407 |
10385
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
408 DOS: |
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
409 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
|
410 Allegro, zlib and libpng, which all can be downloaded from the DJGPP |
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
411 website. Compilation is straight forward: use make, but do a "./configure" |
9709c41adf56
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium <rubidium@openttd.org>
parents:
9945
diff
changeset
|
412 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
|
413 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
|
414 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
|
415 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
|
416 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
|
417 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
418 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
|
419 ---- --------------------------- |
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
|
420 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
|
421 - libSDL/liballegro: hardware access (video, sound, mouse) |
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
|
422 - zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, 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
|
423 - 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
|
424 - 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
|
425 - 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
|
426 - 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
|
427 - 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
|
428 - 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
|
429 natural sorting of strings. |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
430 |
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
|
431 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
|
432 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
|
433 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
|
434 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
|
435 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
|
436 |
15815
765da3a9893d
(svn r20490) -Change: merge the extra GRF sources so updating them becomes a bit easier.
rubidium <rubidium@openttd.org>
parents:
15607
diff
changeset
|
437 To recompile the extra graphics needed to play with the original Transport |
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
|
438 Tycoon Deluxe graphics you need GRFCodec (which includes NFORenum) as well. |
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
|
439 GRFCodec can be found at: http://www.openttd.org/download-grfcodec |
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
|
440 The compilation of these extra graphics does generally not happen, unless |
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
|
441 you remove the graphics file using "make maintainer-clean". |
15815
765da3a9893d
(svn r20490) -Change: merge the extra GRF sources so updating them becomes a bit easier.
rubidium <rubidium@openttd.org>
parents:
15607
diff
changeset
|
442 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
443 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
|
444 ---- ------------------- |
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
|
445 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
|
446 - 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
|
447 Version 2005 gives bogus warnings about scoping issues. |
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
448 - GNU Compiler Collection (GCC) 3.3 - 4.6. |
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
|
449 Versions 4.1 and earlier give bogus warnings about uninitialised variables. |
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
|
450 Versions 4.4 and later give bogus warnings about freeing heap objects. |
16559
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
451 - Intel C++ Compiler (ICC) 12.0. |
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
|
452 |
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
|
453 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
|
454 - 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
|
455 - 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
|
456 These old versions fail due to OpenTTD's template usage. |
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
457 - Intel C++ Compiler (ICC) 11.1 and earlier. |
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
458 Version 10.0 and earlier fail a configure check and fail with recent system headers. |
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
459 Version 10.1 fails to compile station_gui.cpp. |
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
460 Version 11.1 fails with internal error when compiling network.cpp. |
501ce98e1480
(svn r21287) -Document: update information about supported compilers
smatz <smatz@openttd.org>
parents:
16552
diff
changeset
|
461 - 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
|
462 - (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
|
463 |
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
|
464 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
|
465 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
|
466 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
467 |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
468 8.0) Translating |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
469 ---- ----------- |
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
|
470 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
|
471 |
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
|
472 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
|
473 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
|
474 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
|
475 |
2401
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
476 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
|
477 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
|
478 |
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
|
479 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
|
480 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
|
481 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
|
482 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
483 8.1) Translation |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
484 ---- ----------- |
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
|
485 So, now that you've notified the development team about your intention to |
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
486 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
|
487 (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
|
488 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
489 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
|
490 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
491 ##name English-Name-Of-Language |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
492 ##ownname Native-Name-Of-Language |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
493 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
494 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
|
495 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
496 * 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
|
497 * 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
|
498 * 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
|
499 the file |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
500 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
501 8.2) Previewing |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
502 ---- ---------- |
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
|
503 In order to view the translation in the game, you need to compile your language |
10583
119424494408
(svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents:
10515
diff
changeset
|
504 file with the strgen utility. You can download the precompiled strgen from: |
119424494408
(svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents:
10515
diff
changeset
|
505 http://www.openttd.org/download-strgen |
119424494408
(svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents:
10515
diff
changeset
|
506 To compile it yourself just take the normal OpenTTD sources and build that. |
119424494408
(svn r14846) -Doc: strgen hasn't been part of the trunk/release binaries for quite a while, so point to the precompiled strgen package instead.
rubidium <rubidium@openttd.org>
parents:
10515
diff
changeset
|
507 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
|
508 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
509 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
|
510 Example: |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
511 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
512 strgen lang/german.txt |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
513 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
514 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
|
515 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
|
516 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
|
517 should also be. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
518 |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
519 That's all! You should now be able to select the language in the game options. |
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
520 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
521 |
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
|
522 9.0) Troubleshooting |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
523 ---- --------------- |
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
|
524 To see all startup options available to you, start OpenTTD with the |
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
525 "./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
|
526 |
3122
ccf65121c0c0
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents:
2946
diff
changeset
|
527 If the game is acting strange and you feel adventurous you can try the |
2401
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
528 "-d [[<name>]=[<level>]" flag, where the higher levels will give you more |
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
529 debugging output. The "name" variable can help you to display only some type of |
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
530 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
|
531 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
|
532 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
|
533 |
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
|
534 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
|
535 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
|
536 |
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
|
537 Under, especially, Ubuntu OpenTTD can be extremely slow and freeze/hand under |
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
|
538 certain circumstance. See known-bugs.txt for more information and how to |
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
|
539 solve this problem on your computer. |
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
540 |
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
|
541 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
|
542 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
|
543 for their stability. |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
544 |
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
545 With the added support for font-based text selecting a non-latin language will |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
546 result in garbage (lots of '?') shown on screen. Please open your configuration |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
547 file and add a desired font for small/medium/-and large_font. This can be a font |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
548 name like "Tahoma" or a path to a font. |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
549 |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
550 Any NewGRF file used in a game is stored inside the savegame and will refuse |
13453
ab95ef079c82
(svn r17962) -Fix: some spelling
rubidium <rubidium@openttd.org>
parents:
13172
diff
changeset
|
551 to load if you don't have that NewGRF file available. A list of missing files |
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
552 will be output to the console at the moment, so use the '-d' flag (on windows) |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
553 to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/) |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
554 put them in the data/ folder and you're set to go. |
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
555 |
17086
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
556 |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
557 X.X) Credits |
7986f89e6d4b
(svn r21823) -Documentation: update the style used in several documentation files
smatz <smatz@openttd.org>
parents:
17013
diff
changeset
|
558 ---- ------- |
1124
405b7f9410be
(svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents:
961
diff
changeset
|
559 The OpenTTD team (in alphabetical order): |
13587
f5704f568df1
(svn r18111) -Change: One more developer added to the history of OpenTTD.
alberth <alberth@openttd.org>
parents:
13453
diff
changeset
|
560 Albert Hofkamp (Alberth) - GUI expert |
14450
94d7ee68af4e
(svn r19007) -Prepare: 1.0.0-beta4
rubidium <rubidium@openttd.org>
parents:
14441
diff
changeset
|
561 Jean-François Claeys (Belugas) - GUI, newindustries and more |
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
|
562 Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework |
9945
538705a4c605
(svn r14100) -Fix(r14099): Who reads readme.txt files anyway?. Same work as previous commit.
belugas <belugas@openttd.org>
parents:
9704
diff
changeset
|
563 Christoph Elsenhans (frosch) - General coding |
11369
41fcb66a1256
(svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents:
11311
diff
changeset
|
564 Loïc Guilloux (glx) - Windows Expert |
10453
645c83f6f00c
(svn r14708) -Change: update a few urls and fix some small errors/missing things in a few documents.
rubidium <rubidium@openttd.org>
parents:
10399
diff
changeset
|
565 Michael Lutz (michi_cc) - Path based signals |
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
566 Owen Rudge (orudge) - Forum host, OS/2 port |
8184
060e78474842
(svn r11747) -Change: Return of the prodigal son (or something). Little update (but highly noticed) on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8059
diff
changeset
|
567 Peter Nelson (peter1138) - Spiritual descendant from newGRF gods |
16239
308a826df5ed
(svn r20940) -Fix (r20928): switch to the normal alphabet where 'b' comes before 'p'
yexo <yexo@openttd.org>
parents:
16227
diff
changeset
|
568 Ingo von Borstel (planetmaker) - Support |
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
|
569 Remko Bijker (Rubidium) - Lead coder and way more |
13063
d6196415e66a
(svn r17561) -Fix: diacritics was missing at few places
smatz <smatz@openttd.org>
parents:
13058
diff
changeset
|
570 Zdeněk Sojka (SmatZ) - Bug finder and fixer |
14441
ccb369c0139e
(svn r18998) -Update: the credits
rubidium <rubidium@openttd.org>
parents:
14348
diff
changeset
|
571 José Soler (Terkhen) - General coding |
11369
41fcb66a1256
(svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents:
11311
diff
changeset
|
572 Thijs Marinussen (Yexo) - AI Framework |
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
573 |
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
|
574 Inactive Developers: |
14441
ccb369c0139e
(svn r18998) -Update: the credits
rubidium <rubidium@openttd.org>
parents:
14348
diff
changeset
|
575 Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles |
ccb369c0139e
(svn r18998) -Update: the credits
rubidium <rubidium@openttd.org>
parents:
14348
diff
changeset
|
576 Victor Fischer (Celestar) - Programming everywhere you need him to |
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
|
577 Tamás Faragó (Darkvater) - Ex-Lead coder |
11369
41fcb66a1256
(svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents:
11311
diff
changeset
|
578 Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) |
41fcb66a1256
(svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents:
11311
diff
changeset
|
579 Jonathan Coome (Maedhros) - High priest of the NewGRF Temple |
12744
354ab0f30d7b
(svn r17210) -Update: credits to reflect the (current) truth a bit better
rubidium <rubidium@openttd.org>
parents:
12716
diff
changeset
|
580 Attila Bán (MiHaMiX) - WebTranslator 1 and 2 |
1125
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
581 Christoph Mallon (Tron) - Programmer, code correctness police |
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
582 |
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
583 Retired Developers: |
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
584 Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) |
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
585 Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) |
1703
2bd7418694e2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents:
1694
diff
changeset
|
586 Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) |
11369
41fcb66a1256
(svn r15719) -Update: the credit section.
yexo <yexo@openttd.org>
parents:
11311
diff
changeset
|
587 Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker |
12744
354ab0f30d7b
(svn r17210) -Update: credits to reflect the (current) truth a bit better
rubidium <rubidium@openttd.org>
parents:
12716
diff
changeset
|
588 Patric Stout (TrueLight) - Programmer (0.3 - pre0.7), sys op (active) |
799
ca9bb7e58029
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents:
614
diff
changeset
|
589 |
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
590 Thanks to: |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
591 Josef Drexler - For his great work on TTDPatch. |
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
|
592 Marcin Grzegorczyk - For his TTDPatch work and documentation of Transport Tycoon Deluxe internals and graphics (signals and track foundations) |
13063
d6196415e66a
(svn r17561) -Fix: diacritics was missing at few places
smatz <smatz@openttd.org>
parents:
13058
diff
changeset
|
593 Petr Baudiš (pasky) - Many patches, newgrf support, etc. |
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
594 Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
595 Stefan Meißner (sign_de) - For his work on the console |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
596 Mike Ragsdale - OpenTTD installer |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
597 Cian Duffy (MYOB) - BeOS port / manual writing |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
598 Christian Rosentreter (tokai) - MorphOS / AmigaOS port |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
599 Richard Kempton (RichK67) - Additional airports, initial TGP implementation |
11225
b99d60de9a5d
(svn r15578) -Change: unexternalise squirrel.
rubidium <rubidium@openttd.org>
parents:
11154
diff
changeset
|
600 Alberto Demichelis - Squirrel scripting language |
12777
5732e685a232
(svn r17247) -Change: move '3rd party' MD5 implementation also to the 3rdparty directory.
rubidium <rubidium@openttd.org>
parents:
12744
diff
changeset
|
601 L. Peter Deutsch - MD5 implementation |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
602 Michael Blunck - For revolutionizing TTD with awesome graphics |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
603 George - Canal graphics |
6691
d2fb32d942f7
(svn r9923) -Add: support for Action 0 Road vehicles, property 1C, bit 0.
rubidium <rubidium@openttd.org>
parents:
6673
diff
changeset
|
604 David Dallaston (Pikka) - Tram tracks |
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
605 All Translators - For their support to make OpenTTD a truly international game |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
606 Bug Reporters - Thanks for all bug reports |
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
607 Chris Sawyer - For an amazing game! |