Mercurial > hg > openttd
annotate readme.txt @ 9494:3503f9917e4a draft
(svn r13472) -Backport (r13467 from NoAI): make CmdRemoveRoadStop use p2 as documented (only look at bit 0, not at the complete value)
| author | glx <glx@openttd.org> |
|---|---|
| date | Wed, 11 Jun 2008 15:08:52 +0000 |
| parents | 267a95510fdf |
| children | e56e094a5f92 |
| 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 |
|
8672
c09014b394a6
(svn r12337) -Change: update some documentation.
belugas <belugas@openttd.org>
parents:
8659
diff
changeset
|
2 Last updated: 2008-03-04 |
|
c09014b394a6
(svn r12337) -Change: update some documentation.
belugas <belugas@openttd.org>
parents:
8659
diff
changeset
|
3 Release version: 0.6.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 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
7 Table of Contents: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
8 ------------------ |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
9 1.0) About |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
10 2.0) Contacting |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
11 * 2.1 Reporting Bugs |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
12 3.0) Supported Platforms |
|
7686
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
13 4.0) Installing and running OpenTTD |
|
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
14 * 4.1 (Required) 3rd party files |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
15 * 4.2 OpenTTD directories |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
16 * 4.3 Portable Installations (External Media) |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
17 5.0) OpenTTD features |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
18 6.0) Configuration File |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
19 7.0) Compiling |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
20 8.0) Translating |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
21 * 8.1 Guidelines |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
22 * 8.2 Translation |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
23 * 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
|
24 9.0) Troubleshooting |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
25 X.X) Credits |
|
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 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
28 1.0) About: |
|
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 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
|
31 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
|
32 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
|
33 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
34 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
|
35 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
|
36 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
37 2.0) Contacting: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
38 ---- ---------- |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
39 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
|
40 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
|
41 on irc.oftc.net). |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
42 |
|
250
9995f44f61b7
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents:
222
diff
changeset
|
43 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
|
44 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
45 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
|
46 http://forum.openttd.org/ |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
47 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
48 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
49 2.1) Reporting Bugs: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
50 ---- --------------- |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
51 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
|
52 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
|
53 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
|
54 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
|
55 is not already known. |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
56 |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
57 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
|
58 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
59 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
|
60 - 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
|
61 - 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
|
62 - Platform and compiler (Win32, Linux, FreeBSD, ...) |
|
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
|
63 - Attach a saved game *and* a screenshot if possible |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
64 - 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
|
65 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
|
66 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
|
67 changes made. |
|
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 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
70 3.0) Supported Platforms: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
71 ---- -------------------- |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
72 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
|
73 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
|
74 are: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
75 |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
76 BeOS - SDL |
|
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
77 FreeBSD - SDL |
|
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
78 Linux - SDL |
|
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
79 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
|
80 MorphOS - SDL |
|
6673
b42a1e412f8e
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents:
6514
diff
changeset
|
81 OpenBSD - SDL |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
82 OS/2 - SDL |
|
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
83 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
|
84 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
85 |
|
7686
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
86 4.0) Installing and running OpenTTD: |
|
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
87 ---- ------------------------------- |
|
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
88 |
|
48c969ebb8ba
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium <rubidium@openttd.org>
parents:
7588
diff
changeset
|
89 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
|
90 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
|
91 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
|
92 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
|
93 |
|
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
|
94 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
|
95 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
|
96 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
|
97 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
|
98 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
|
99 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
|
100 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
|
101 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
|
102 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
|
103 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
|
104 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
|
105 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
106 4.1) (Required) 3rd party files: |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
107 ---- --------------------------- |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
108 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
109 Before you run OpenTTD, you need to put the game's datafiles into a data/ |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
110 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
|
111 section. |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
112 As OpenTTD makes use of the original TTD artwork you will need the files listed |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
113 below, which you can find on a Transport Tycoon Deluxe CD-ROM. |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
114 The Windows installer optionally can copy these files from that CD-ROM. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
115 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
116 List of the required files: |
|
8659
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
117 - sample.cat |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
118 - trg1r.grf |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
119 - trgcr.grf |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
120 - trghr.grf |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
121 - trgir.grf |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
122 - trgtr.grf |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
123 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
124 Alternatively you can use the TTD GRF files from the DOS version: |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
125 - TRG1.GRF |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
126 - TRGC.GRF |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
127 - TRGH.GRF |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
128 - TRGI.GRF |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
129 - TRGT.GRF |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
130 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
131 If you want the TTD music, copy the gm/ folder from the Windows version |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
132 of TTD to your OpenTTD folder (not your data folder - also explained in |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
133 the following sections). |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
134 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
135 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
|
136 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
|
137 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
|
138 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
139 4.2) OpenTTD directories |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
140 ---- ------------------------------- |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
141 |
|
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
|
142 The TTD artwork files listed in the section 4.1 "(Required) 3rd party files" |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
143 can be placed in a few different locations: |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
144 1. The current working directory (from where you started OpenTTD) |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
145 2. Your personal directory |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
146 Windows: C:\Documents and Settings\<username>\My Documents\OpenTTD |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
147 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
|
148 Linux: ~/.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
|
149 3. The shared 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
|
150 Windows: C:\Documents and Settings\All Users\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
|
151 Mac OSX: /Library/Application Support/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
|
152 Linux: not available |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
153 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
|
154 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
|
155 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
|
156 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
|
157 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
|
158 6. The application bundle (Mac OSX 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
|
159 It includes the OTTD 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
|
160 |
|
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
|
161 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
|
162 - Linux in the previous list means .deb, but most paths should be similar for others. |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
163 - The previous search order is also used for newgrfs and 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
|
164 - 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
|
165 - 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
|
166 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
|
167 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
|
168 |
|
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 The prefered setup: |
|
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 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
|
171 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
|
172 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
|
173 |
|
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 |
|
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 4.3) Portable Installations (External Media): |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
176 ---- ---------------------------------------- |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
177 |
|
8a48f9c9188e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx <glx@openttd.org>
parents:
8605
diff
changeset
|
178 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
|
179 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
|
180 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
|
181 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
|
182 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
|
183 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
|
184 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
|
185 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
|
186 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
|
187 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
|
188 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
189 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
190 5.0) OpenTTD features: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
191 ---- ----------------- |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
192 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
193 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
|
194 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
|
195 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
|
196 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
|
197 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
|
198 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
199 Several important non-standard controls: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
200 |
|
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
|
201 * Use Ctrl to place semaphore signals |
|
240a3baa3b56
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron <tron@openttd.org>
parents:
2134
diff
changeset
|
202 * 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
|
203 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
|
204 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
205 |
|
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
|
206 5.1) Logging of potentially dangerous actions: |
|
267a95510fdf
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz <smatz@openttd.org>
parents:
8672
diff
changeset
|
207 ---- ---------------------------------------- |
|
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
|
208 |
|
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
|
209 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
|
210 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
|
211 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
|
212 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
|
213 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
|
214 game usability for many players. We certainly do not want that. |
|
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
|
215 However, we receive bugreports because of this. To reduce time spent with |
|
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
|
216 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
|
217 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
|
218 |
|
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
|
219 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
|
220 |
|
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
|
221 * 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
|
222 * 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
|
223 * Changing game mode (scenario editor <-> normal game) |
|
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
|
224 * Loading game saved in a different OTTD / TTDPatch / TTD version |
|
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
|
225 * Running a modified OTTD build |
|
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
|
226 * Changing patch settings affecting NewGRF behaviour (non-networksafe patches) |
|
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
|
227 * Changing landscape (by cheat) |
|
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
|
228 |
|
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
|
229 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
|
230 |
|
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
|
231 You can show the gamelog by typing 'gamelog' in the console or by running |
|
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
|
232 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
|
233 |
|
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
|
234 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
235 6.0) Configuration File: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
236 ---- ------------------- |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
237 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
|
238 .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
|
239 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
|
240 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
241 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
242 7.0) Compiling: |
|
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 Windows: |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
245 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
|
246 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
|
247 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
|
248 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
|
249 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
|
250 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
|
251 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
|
252 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
|
253 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
|
254 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
255 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
|
256 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
|
257 |
|
6219
246a4090287a
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar <celestar@openttd.org>
parents:
6168
diff
changeset
|
258 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
|
259 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
|
260 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
|
261 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
|
262 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
|
263 --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
|
264 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
|
265 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
266 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
|
267 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
|
268 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
|
269 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
|
270 |
|
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
|
271 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
|
272 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
|
273 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
|
274 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
|
275 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
|
276 instead of "./configure". |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
277 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
278 BeOS: |
|
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
279 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
|
280 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
281 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
|
282 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
|
283 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
|
284 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
|
285 |
|
6673
b42a1e412f8e
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents:
6514
diff
changeset
|
286 OpenBSD: |
|
b42a1e412f8e
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138 <peter1138@openttd.org>
parents:
6514
diff
changeset
|
287 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
|
288 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
|
289 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
290 MorphOS: |
|
5475
eabf4b86aed6
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
5443
diff
changeset
|
291 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
|
292 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
|
293 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
|
294 libpng and freetype2 developer files. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
295 |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
296 OS/2: |
|
7045
49110cf8e2d9
(svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge <orudge@openttd.org>
parents:
6744
diff
changeset
|
297 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
|
298 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
|
299 |
|
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
300 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
301 8.0) Translating: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
302 ---- ------------------- |
|
250
9995f44f61b7
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater <darkvater@openttd.org>
parents:
222
diff
changeset
|
303 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
|
304 |
|
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
|
305 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
|
306 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
|
307 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
|
308 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
|
309 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
|
310 |
|
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
|
311 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
|
312 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
|
313 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
314 8.1) Guidelines: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
315 ---- ------------------- |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
316 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
|
317 |
|
3122
ccf65121c0c0
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents:
2946
diff
changeset
|
318 * 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
|
319 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
|
320 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
|
321 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
322 8.2) Translation: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
323 ---- ------------------- |
|
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
|
324 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
|
325 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
|
326 (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
|
327 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
328 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
|
329 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
330 ##name English-Name-Of-Language |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
331 ##ownname Native-Name-Of-Language |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
332 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
333 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
|
334 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
335 * 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
|
336 * 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
|
337 * 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
|
338 the file |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
339 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
340 8.3) Previewing: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
341 ---- ------------------- |
|
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
|
342 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
|
343 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
|
344 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
345 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
|
346 Example: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
347 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
348 strgen lang/german.txt |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
349 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
350 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
|
351 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
|
352 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
|
353 should also be. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
354 |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
355 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
|
356 |
|
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
|
357 9.0) Troubleshooting |
|
1734
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
358 ---- --------------- |
|
d37fcb08ac21
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater <Darkvater@openttd.org>
parents:
1703
diff
changeset
|
359 |
|
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
|
360 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
|
361 "./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
|
362 |
|
3122
ccf65121c0c0
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater <Darkvater@openttd.org>
parents:
2946
diff
changeset
|
363 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
|
364 "-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
|
365 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
|
366 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
|
367 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
|
368 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
|
369 |
|
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
|
370 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
|
371 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
|
372 |
|
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
|
373 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
|
374 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
|
375 for their stability. |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
376 |
|
5355
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
377 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
|
378 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
|
379 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
|
380 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
|
381 |
|
4449e5529205
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater <Darkvater@openttd.org>
parents:
4785
diff
changeset
|
382 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
|
383 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
|
384 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
|
385 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
|
386 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
|
387 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
388 X.X) Credits: |
|
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
389 ---- -------- |
|
1124
405b7f9410be
(svn r1625) -Alphabetized credits list
darkvater <darkvater@openttd.org>
parents:
961
diff
changeset
|
390 The OpenTTD team (in alphabetical order): |
|
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
391 Jean-Francois Claeys (Belugas) - GUI, newindustries and more |
|
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
392 Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles |
|
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
393 Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework |
|
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
|
394 Loïc Guilloux (glx) - General coding |
|
8605
effdced88525
(svn r12187) -Add: frosch as dev. Last, but not least
belugas <belugas@openttd.org>
parents:
8600
diff
changeset
|
395 Christoph Elsenhans (frosch) - General coding |
|
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
|
396 Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) |
|
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
|
397 Jonathan Coome (Maedhros) - High priest of the newGRF Temple |
|
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
|
398 Attila Bán (MiHaMiX) - WebTranslator, Nightlies, Wiki and bugtracker host |
|
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
|
399 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
|
400 Peter Nelson (peter1138) - Spiritual descendant from newGRF gods |
|
8059
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
401 Remko Bijker (Rubidium) - Lead coder and way more |
|
3cb0afbc2249
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas <belugas@openttd.org>
parents:
8052
diff
changeset
|
402 Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker |
|
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
|
403 Zdenek Sojka (SmatZ) - Bug finder and fixer |
|
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
|
404 |
|
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
|
405 Inactive Developers: |
|
1125
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
406 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
|
407 Tamás Faragó (Darkvater) - Ex-Lead coder |
|
1125
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
408 Christoph Mallon (Tron) - Programmer, code correctness police |
|
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
409 |
|
de436fc47e5f
(svn r1626) -Updated readme and credits list.
darkvater <darkvater@openttd.org>
parents:
1124
diff
changeset
|
410 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
|
411 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
|
412 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
|
413 Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) |
|
7859
51d89ad22764
(svn r11409) -Update: as of now, I am a retired Developer, so mark me as such
truelight <truelight@openttd.org>
parents:
7686
diff
changeset
|
414 Patric Stout (TrueLight) - Programmer, webhoster (0.3 - pre0.6) |
|
799
ca9bb7e58029
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight <truelight@openttd.org>
parents:
614
diff
changeset
|
415 |
|
0
fa6ee4d75c8a
(svn r1) Import of revision 975 of old (crashed) SVN
truelight <truelight@openttd.org>
parents:
diff
changeset
|
416 Thanks to: |
|
5404
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
417 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
|
418 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
|
419 Petr Baudis (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
|
420 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
|
421 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
|
422 Mike Ragsdale - OpenTTD installer |
|
2a651add2378
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents:
5397
diff
changeset
|
423 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
|
424 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
|
425 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
|
426 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
|
427 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
|
428 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
|
429 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
|
430 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
|
431 Chris Sawyer - For an amazing game! |