annotate readme.txt @ 6744:267368109c7f draft

(svn r9979) -Merge: release changes from 0.5.
author rubidium <rubidium@openttd.org>
date Tue, 29 May 2007 18:55:15 +0000
parents d2fb32d942f7
children 49110cf8e2d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
1 OpenTTD README
6744
267368109c7f (svn r9979) -Merge: release changes from 0.5.
rubidium <rubidium@openttd.org>
parents: 6691
diff changeset
2 Last updated: 2007-05-29
267368109c7f (svn r9979) -Merge: release changes from 0.5.
rubidium <rubidium@openttd.org>
parents: 6691
diff changeset
3 Release version: 0.5.2
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
4 ------------------------------------------------------------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
5
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
6
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
7 Table of Contents:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
8 ------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
9 1.0) About
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
10 2.0) Contacting
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
11 * 2.1 Reporting Bugs
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
12 3.0) Supported Platforms
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
13 4.0) Running OpenTTD
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
14 5.0) OpenTTD features
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
15 6.0) Configuration File
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
16 7.0) Compiling
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
17 8.0) Translating
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
18 * 8.1 Guidelines
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
19 * 8.2 Translation
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
20 * 8.3 Previewing
1703
2bd7418694e2 (svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater <Darkvater@openttd.org>
parents: 1694
diff changeset
21 9.0) Troubleshooting
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
22 X.X) Credits
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
23
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
24
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
25 1.0) About:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
26 ---- ------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
27 OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
28 written by Chris Sawyer. It attempts to mimic the original game as closely
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
29 as possible while extending it with new features.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
30
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
31 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
32 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
33
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
34 2.0) Contacting:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
35 ---- ----------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
36 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
37 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
38 on irc.oftc.net).
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
39
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
40 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
41
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
42 You can also find the OpenTTD forums at
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
43 http://www.tt-forums.net/index.php?c=20
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
44
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
45
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
46 2.1) Reporting Bugs:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
47 ---- ---------------
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
48 To report a bug, please create a Flyspray account and follow the bugs
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
49 link from our homepage. Please make sure the bug is reproducible and
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
50 still occurs in the latest daily build or the current SVN version. Also
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
51 please look through the existing bug reports briefly to see whether the bug
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
52 is not already known.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
53
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
54 The Flyspray project page URL is: http://bugs.openttd.org/
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
55
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
56 Please include the following information in your bug report:
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
57 - OpenTTD version (PLEASE test the latest SVN/nightly build)
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
58 - Bug details, including instructions how to reproduce it
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
59 - Platform and compiler (Win32, Linux, FreeBSD, ...)
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
60 - Attach a saved game or a screenshot if possible
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
61 - If this bug only occurred recently please note the last
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
62 version without the bug and the first version including
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
63 the bug. That way we can fix it quicker by looking at the
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
64 changes made.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
65
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
66
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
67 3.0) Supported Platforms:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
68 ---- --------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
69 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
70 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
71 are:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
72
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
73 BeOS - SDL
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
74 FreeBSD - SDL
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
75 Linux - SDL
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
76 MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary)
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
77 MorphOS - SDL
6673
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
78 OpenBSD - SDL
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
79 OS/2 - SDL
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
80 Windows - Win32 GDI (faster) or SDL
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
81
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
82
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
83 4.0) Running OpenTTD:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
84 ---- ----------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
85
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
86 Before you run OpenTTD, you need to put the game's datafiles into the data/
614
96f116271012 (svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik <dominik@openttd.org>
parents: 504
diff changeset
87 subdirectory. You need the following files from the original version
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
88 of TTD as OpenTTD makes use of the original TTD artwork.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
89
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
90 List of the required files:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
91 sample.cat
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
92 trg1r.grf
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
93 trgcr.grf
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
94 trghr.grf
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
95 trgir.grf
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
96 trgtr.grf
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
97
799
ca9bb7e58029 (svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents: 614
diff changeset
98 (Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF,
2748
b299210e3287 (svn r3293) - Miscellaneous: add peter1138 as developer
Darkvater <Darkvater@openttd.org>
parents: 2401
diff changeset
99 TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with
b299210e3287 (svn r3293) - Miscellaneous: add peter1138 as developer
Darkvater <Darkvater@openttd.org>
parents: 2401
diff changeset
100 the DOS graphics remain. E.g. the autorail button in the rail toolbar doesn't
961
8ca2991f893e (svn r1453) Feature: MD5 hash check for TTD files
dominik <dominik@openttd.org>
parents: 799
diff changeset
101 look as nice as with the Windows graphics.)
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
102
799
ca9bb7e58029 (svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents: 614
diff changeset
103 If you want music you need to copy the gm/ folder from Windows TTD into your
614
96f116271012 (svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik <dominik@openttd.org>
parents: 504
diff changeset
104 OpenTTD folder, not your data folder.
96f116271012 (svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik <dominik@openttd.org>
parents: 504
diff changeset
105
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
106 You can change the data path (which contains savegames as well) in
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
107 Makefile.config by setting DATA_DIR_PREFIX and USE_HOMEDIR.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
108
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
109
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
110 5.0) OpenTTD features:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
111 ---- -----------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
112
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
113 OpenTTD has a lot of features going beyond the original TTD emulation.
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
114 Unfortunately, there is currently no comprehensive list of features, but there
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
115 is a basic features list on the web, and some optional features can be
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
116 controlled through the Configure Patches dialog. We also implement some
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
117 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
118
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
119 Several important non-standard controls:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
120
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
121 * Use Ctrl to place semaphore signals
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
122 * Ctrl-D toggles double mode in the Windows version
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
123 * 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
124 http://wiki.openttd.org/index.php/Console
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
125
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
126
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
127 6.0) Configuration File:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
128 ---- -------------------
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
129 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
130 .INI format. It's mostly undocumented. Almost all settings can be changed
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
131 ingame by using the 'Configure Patches' window.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
132
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
133
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
134 7.0) Compiling:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
135 ---- ----------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
136 Windows:
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
137 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
138 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
139 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
140 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
141 to work you need their development files. For best results, download 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
142 openttd-useful.zip file from SourceForge under the Files tab. Put the header
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
143 files into your compiler's include/ directory and the library (.lib) files
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
144 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
145 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
146
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
147 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
148 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
149
6219
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
150 Solaris 10:
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
151 You need g++ (version 3 or higher), together with SDL. Installation of
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
152 libpng and zlib is recommended. For the first build it is required
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
153 to execute "bash configure" first. Note that ./configure does not work
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
154 yet. It is likely that you don't have a strip binary, so use the
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
155 --disable-strip option in that case. Fontconfig (>2.3.0) and freetype
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
156 are optional. "make run" will then run the program.
246a4090287a (svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents: 6168
diff changeset
157
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
158 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
159 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
160 However, for the first build one has to do a "./configure" first.
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
161 Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
162
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
163 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
164 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
165 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
166 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
167 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
168 instead of "./configure".
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
169
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
170 BeOS:
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
171 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
172
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
173 FreeBSD:
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
174 You need the port devel/sdl12 for a non-dedicated build.
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
175 graphics/png is optional for screenshots in the PNG format.
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
176 Use "gmake", 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
177
6673
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
178 OpenBSD:
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
179 Use "gmake", but do a "./configure" before the first build.
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
180 Note that you need the port devel/sdl to compile OpenTTD.
b42a1e412f8e (svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents: 6514
diff changeset
181
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
182 MorphOS:
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents: 5443
diff changeset
183 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
184 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
185 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
186 libpng and freetype2 developer files.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
187
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
188 OS/2:
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
189 Open Watcom C/C++ 1.3 or later is required to build the OS/2 version. See the
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
190 docs/Readme_OS2.txt file for more information.
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
191
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
192
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
193 8.0) Translating:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
194 ---- -------------------
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
195 See http://www.openttd.org/translating.php for up-to-date information.
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
196
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
197 The use of the online Translator service, located at
4785
7c3a3b9e6cb2 (svn r6699) -Fixed translator link in readme
Darkvater <Darkvater@openttd.org>
parents: 4254
diff changeset
198 http://translator2.openttd.org/, is highly encouraged. For a username/password
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
199 combo you should contact the development team, either by mail, IRC or 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
200 forums. The system is straightforward to use, and if you have any problems,
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
201 read the online help located there.
250
9995f44f61b7 (svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents: 222
diff changeset
202
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
203 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
204 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
205
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
206 8.1) Guidelines:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
207 ---- -------------------
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
208 Here are some translation guidelines which you should follow closely.
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
209
3122
ccf65121c0c0 (svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents: 2946
diff changeset
210 * Please contact the development team before beginning the translation
2401
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
211 process! This avoids double work, as someone else may have already
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
212 started translating to the same language.
3122
ccf65121c0c0 (svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents: 2946
diff changeset
213 * Translators must use the character set ISO 8859-15.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
214 Otherwise, some characters will not display correctly in the game.
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
215 * Currently it is not possible to translate into character sets other than
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
216 Latin.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
217
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
218 8.2) Translation:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
219 ---- -------------------
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
220 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
221 translate (You did, right? Of course you did.) you can pick up english.txt
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
222 (found in the SVN repository under /lang) and translate.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
223
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
224 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
225
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
226 ##name English-Name-Of-Language
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
227 ##ownname Native-Name-Of-Language
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
228
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
229 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
230
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
231 * 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
232 * 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
233 * 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
234 the file
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
235
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
236 8.3) Previewing:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
237 ---- -------------------
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
238 In order to view the translation in the game, you need to compile your language
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
239 file with the strgen utility, which is now bundled with the game.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
240
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
241 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
242 Example:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
243
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
244 strgen lang/german.txt
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
245
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
246 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
247 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
248 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
249 should also be.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
250
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
251 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
252
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
253 9.0) Troubleshooting
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
254 ---- ---------------
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
255
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
256 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
257 "./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
258
3122
ccf65121c0c0 (svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents: 2946
diff changeset
259 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
260 "-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
261 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
262 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
263 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
264 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
265
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
266 The most frequent problem is missing data files. Don't forget to put all GRF
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
267 files from TTD into your data/ folder including sample.cat!
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
268
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
269 Under Windows 98 and lower it is impossible to use a dedicated server; it will
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
270 fail to start. Perhaps this is for the better because those OS's are not known
240a3baa3b56 (svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents: 2134
diff changeset
271 for their stability.
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
272
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
273 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
274 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
275 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
276 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
277
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
278 Any NewGRF file used in a game is stored inside the savegame and will refuse
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
279 to load if you don't have that grf file available. A list of missing files
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
280 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
281 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
282 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
283
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
284 X.X) Credits:
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
285 ---- --------
1124
405b7f9410be (svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents: 961
diff changeset
286 The OpenTTD team (in alphabetical order):
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
287 Jean-Francois Claeys (Belugas) - In training, not yet specialized
1734
d37fcb08ac21 (svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents: 1703
diff changeset
288 Bjarni Corfitzen (Bjarni) - Mac OS X port, coder
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
289 Matthijs Kooijman (blathijs) - Pathfinder-guru
1125
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
290 Victor Fischer (Celestar) - Programming everywhere you need him to
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
291 Tamás Faragó (Darkvater) - Lead programmer
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
292 Loïc Guilloux (glx) - In training, not yet specialized
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
293 Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;)
1124
405b7f9410be (svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents: 961
diff changeset
294 Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
295
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
296 Peter Nelson (peter1138) - Spiritual descendant from newgrf gods
5726
9f56eacb1878 (svn r8254) -Merge: Release changes from the 0.5 branch back to trunk. This ensures an updated changelog, readme, et.
Darkvater <Darkvater@openttd.org>
parents: 5564
diff changeset
297 Remko Bijker (Rubidium) - THE desync hunter
1125
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
298 Christoph Mallon (Tron) - Programmer, code correctness police
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
299 Patric Stout (TrueLight) - Programmer, network guru, SVN-repository and website host
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
300
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
301 Retired Developers:
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
302 Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6)
5355
4449e5529205 (svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents: 4785
diff changeset
303 Owen Rudge (orudge) - Contributor, forum host, master server host, OS/2 port (0.1 - 0.4.8)
1125
de436fc47e5f (svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents: 1124
diff changeset
304 Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3)
799
ca9bb7e58029 (svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents: 614
diff changeset
305 Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3)
ca9bb7e58029 (svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents: 614
diff changeset
306
0
fa6ee4d75c8a (svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff changeset
307 Thanks to:
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
308 Josef Drexler - For his great work on TTDPatch.
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
309 Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations)
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
310 Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
311 Petr Baudis (pasky) - Many patches, newgrf support, etc.
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
312 Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS)
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
313 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
314 Mike Ragsdale - OpenTTD installer
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
315 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
316 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
317 Richard Kempton (RichK67) - Additional airports, initial TGP implementation
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 5397
diff changeset
318 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
319 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
320 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
321 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
322 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
323 Chris Sawyer - For an amazing game!