author | translators |
Wed, 17 Dec 2008 18:01:19 +0000 | |
changeset 10433 | 45f92593bd6e |
parent 10399 | 129857a93786 |
permissions | -rw-r--r-- |
0 | 1 |
OpenTTD README |
10399
129857a93786
(svn r14650) -Merge: changelog etc. changes from the 0.6 branch.
rubidium
parents:
10385
diff
changeset
|
2 |
Last updated: 2008-10-01 |
129857a93786
(svn r14650) -Merge: changelog etc. changes from the 0.6 branch.
rubidium
parents:
10385
diff
changeset
|
3 |
Release version: 0.6.3 |
0 | 4 |
------------------------------------------------------------------------ |
5 |
||
6 |
||
7 |
Table of Contents: |
|
8 |
------------------ |
|
9 |
1.0) About |
|
10 |
2.0) Contacting |
|
11 |
* 2.1 Reporting Bugs |
|
12 |
3.0) Supported Platforms |
|
7686
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
13 |
4.0) Installing and running OpenTTD |
8659
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
14 |
* 4.1 (Required) 3rd party files |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
15 |
* 4.2 OpenTTD directories |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
16 |
* 4.3 Portable Installations (External Media) |
0 | 17 |
5.0) OpenTTD features |
18 |
6.0) Configuration File |
|
19 |
7.0) Compiling |
|
20 |
8.0) Translating |
|
21 |
* 8.1 Guidelines |
|
22 |
* 8.2 Translation |
|
23 |
* 8.3 Previewing |
|
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
24 |
9.0) Troubleshooting |
0 | 25 |
X.X) Credits |
26 |
||
27 |
||
28 |
1.0) About: |
|
29 |
---- ------ |
|
30 |
OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally |
|
31 |
written by Chris Sawyer. It attempts to mimic the original game as closely |
|
32 |
as possible while extending it with new features. |
|
33 |
||
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
34 |
OpenTTD is licensed under the GNU General Public License version 2.0. For |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
35 |
more information, see the file 'COPYING'. |
0 | 36 |
|
37 |
2.0) Contacting: |
|
38 |
---- ---------- |
|
39 |
The easiest way to contact the OpenTTD team is by submitting bug reports or |
|
40 |
posting comments in our forums. You can also chat with us on IRC (#openttd |
|
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
41 |
on irc.oftc.net). |
0 | 42 |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
43 |
The OpenTTD homepage is http://www.openttd.org/. |
0 | 44 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
45 |
You can also find the OpenTTD forums at |
7908
baf43fd5daa7
(svn r11460) -Documentation: update some documentation to better match the current state and the state in the nearby future of OpenTTD.
rubidium
parents:
7859
diff
changeset
|
46 |
http://forum.openttd.org/ |
0 | 47 |
|
48 |
||
49 |
2.1) Reporting Bugs: |
|
50 |
---- --------------- |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
51 |
To report a bug, please create a Flyspray account and follow the bugs |
0 | 52 |
link from our homepage. Please make sure the bug is reproducible and |
53 |
still occurs in the latest daily build or the current SVN version. Also |
|
54 |
please look through the existing bug reports briefly to see whether the bug |
|
55 |
is not already known. |
|
56 |
||
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
57 |
The Flyspray project page URL is: http://bugs.openttd.org/ |
0 | 58 |
|
59 |
Please include the following information in your bug report: |
|
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
60 |
- OpenTTD version (PLEASE test the latest SVN/nightly build) |
0 | 61 |
- Bug details, including instructions how to reproduce it |
62 |
- Platform and compiler (Win32, Linux, FreeBSD, ...) |
|
7908
baf43fd5daa7
(svn r11460) -Documentation: update some documentation to better match the current state and the state in the nearby future of OpenTTD.
rubidium
parents:
7859
diff
changeset
|
63 |
- Attach a saved game *and* a screenshot if possible |
0 | 64 |
- If this bug only occurred recently please note the last |
65 |
version without the bug and the first version including |
|
66 |
the bug. That way we can fix it quicker by looking at the |
|
67 |
changes made. |
|
68 |
||
69 |
||
70 |
3.0) Supported Platforms: |
|
71 |
---- -------------------- |
|
72 |
OpenTTD has been ported to several platforms and operating systems. It shouldn't |
|
73 |
be very difficult to port it to a new platform. The currently working platforms |
|
74 |
are: |
|
75 |
||
10385
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
76 |
BeOS - SDL or Allegro |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
77 |
DOS - Allegro |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
78 |
FreeBSD - SDL |
10385
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
79 |
Linux - SDL or Allegro |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
80 |
MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary) |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
81 |
MorphOS - SDL |
6673
edf10cfdee17
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138
parents:
6514
diff
changeset
|
82 |
OpenBSD - SDL |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
83 |
OS/2 - SDL |
10385
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
84 |
Windows - Win32 GDI (faster) or SDL or Allegro |
0 | 85 |
|
86 |
||
7686
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
87 |
4.0) Installing and running OpenTTD: |
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
88 |
---- ------------------------------- |
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
89 |
|
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
90 |
Installing OpenTTD is fairly straightforward. Either you have downloaded an |
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
91 |
archive which you have to extract to a directory where you want OpenTTD to |
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
92 |
be installed, or you have downloaded an installer, which will automatically |
7312c357bb94
(svn r11217) -Update: the readme as some things weren't quite right anymore.
rubidium
parents:
7588
diff
changeset
|
93 |
extract OpenTTD in the given directory. |
0 | 94 |
|
8659
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
95 |
OpenTTD looks in multiple locations to find the required data files (described |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
96 |
in section 4.2). Installing any 3rd party files into a "shared" location has |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
97 |
the advantage that you only need to do this step once, rather than copying the |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
98 |
data files into all OpenTTD versions you have. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
99 |
Savegames, screenshots, etc are saved relative to the config file (openttd.cfg) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
100 |
currently being used. This means that if you use a config file in one of the |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
101 |
shared directories, savegames will reside in the save/ directory next to the |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
102 |
openttd.cfg file there. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
103 |
If you want savegames and screenshots in the directory where the OpenTTD binary |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
104 |
resides, simply have your config file in that location. But if you remove this |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
105 |
config file, savegames will still be in this directory (see notes in section 4.2) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
106 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
107 |
4.1) (Required) 3rd party files: |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
108 |
---- --------------------------- |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
109 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
110 |
Before you run OpenTTD, you need to put the game's datafiles into a data/ |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
111 |
directory which can be located in various places addressed in the following |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
112 |
section. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
113 |
As OpenTTD makes use of the original TTD artwork you will need the files listed |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
114 |
below, which you can find on a Transport Tycoon Deluxe CD-ROM. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
115 |
The Windows installer optionally can copy these files from that CD-ROM. |
0 | 116 |
|
117 |
List of the required files: |
|
8659
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
118 |
- sample.cat |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
119 |
- trg1r.grf |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
120 |
- trgcr.grf |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
121 |
- trghr.grf |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
122 |
- trgir.grf |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
123 |
- trgtr.grf |
0 | 124 |
|
8659
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
125 |
Alternatively you can use the TTD GRF files from the DOS version: |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
126 |
- TRG1.GRF |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
127 |
- TRGC.GRF |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
128 |
- TRGH.GRF |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
129 |
- TRGI.GRF |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
130 |
- TRGT.GRF |
0 | 131 |
|
8659
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
132 |
If you want the TTD music, copy the gm/ folder from the Windows version |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
133 |
of TTD to your OpenTTD folder (not your data folder - also explained in |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
134 |
the following sections). |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
135 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
136 |
Do NOT copy files included with OpenTTD into "shared" directories (explained in |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
137 |
the following sections) as sooner or later you will run into graphical glitches |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
138 |
when using other versions of the game. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
139 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
140 |
4.2) OpenTTD directories |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
141 |
---- ------------------------------- |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
142 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
143 |
The TTD artwork files listed in the section 4.1 "(Required) 3rd party files" |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
144 |
can be placed in a few different locations: |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
145 |
1. The current working directory (from where you started OpenTTD) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
146 |
2. Your personal directory |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
147 |
Windows: C:\Documents and Settings\<username>\My Documents\OpenTTD |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
148 |
Mac OSX: ~/Documents/OpenTTD |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
149 |
Linux: ~/.openttd |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
150 |
3. The shared directory |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
151 |
Windows: C:\Documents and Settings\All Users\Documents\OpenTTD |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
152 |
Mac OSX: /Library/Application Support/OpenTTD |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
153 |
Linux: not available |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
154 |
4. The binary directory (where the OpenTTD executable is) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
155 |
Windows: C:\Program Files\OpenTTD |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
156 |
Linux: /usr/games |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
157 |
5. The installation directory (Linux only) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
158 |
Linux: /usr/share/games/openttd |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
159 |
6. The application bundle (Mac OSX only) |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
160 |
It includes the OTTD files (grf+lng) and it will work as long as they aren't touched |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
161 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
162 |
Notes: |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
163 |
- Linux in the previous list means .deb, but most paths should be similar for others. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
164 |
- The previous search order is also used for newgrfs and openttd.cfg. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
165 |
- If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, 5 order. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
166 |
- Savegames will be relative to the config file only if there is no save/ |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
167 |
directory in paths with higher priority than the config file path, but |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
168 |
autosaves and screenshots will always be relative to the config file. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
169 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
170 |
The prefered setup: |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
171 |
Place 3rd party files in shared directory (or in personal directory if you don't |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
172 |
have write access on shared directory) and have your openttd.cfg config file in |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
173 |
personal directory (where the game will then also place savegames and screenshots). |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
174 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
175 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
176 |
4.3) Portable Installations (External Media): |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
177 |
---- ---------------------------------------- |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
178 |
|
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
179 |
You can install OpenTTD on external media so you can take it with you, i.e. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
180 |
using a USB key, or a USB HDD, etc. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
181 |
Create a directory where you shall store the game in (i.e. OpenTTD/). |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
182 |
Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), data/ and your |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
183 |
openttd.cfg to this directory. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
184 |
You can copy binaries for any operating system into this directory, which will |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
185 |
allow you to play the game on nearly any computer you can attach the external |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
186 |
media to. |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
187 |
As always - additional grf files are stored in the data/ dir (for details, |
807ca8fc0c6e
(svn r12321) -Change: update readme about where openttd looks for files (based on dih work)
glx
parents:
8605
diff
changeset
|
188 |
again, see section 4.1). |
614
b96f987dbf80
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
189 |
|
0 | 190 |
|
191 |
5.0) OpenTTD features: |
|
192 |
---- ----------------- |
|
193 |
||
194 |
OpenTTD has a lot of features going beyond the original TTD emulation. |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
195 |
Unfortunately, there is currently no comprehensive list of features, but there |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
196 |
is a basic features list on the web, and some optional features can be |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
197 |
controlled through the Configure Patches dialog. We also implement some |
0 | 198 |
features known from TTDPatch (http://www.ttdpatch.net/). |
199 |
||
200 |
Several important non-standard controls: |
|
201 |
||
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
202 |
* Use Ctrl to place semaphore signals |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
203 |
* Ingame console. More information at |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
204 |
http://wiki.openttd.org/index.php/Console |
0 | 205 |
|
206 |
||
9457
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
207 |
5.1) Logging of potentially dangerous actions: |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
208 |
---- ---------------------------------------- |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
209 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
210 |
OpenTTD is a complex program, and together with NewGRF, it may show a buggy |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
211 |
behaviour. But not only bugs in code can cause problems. There are several |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
212 |
ways to affect game state possibly resulting in program crash or multiplayer |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
213 |
desyncs. |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
214 |
Easier way would be to forbid all these unsafe actions, but that would affect |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
215 |
game usability for many players. We certainly do not want that. |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
216 |
However, we receive bugreports because of this. To reduce time spent with |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
217 |
solving these problems, these potentially unsafe actions are logged in |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
218 |
the savegame (including crash.sav). Log is stored in crash logs, too. |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
219 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
220 |
Information logged: |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
221 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
222 |
* Adding / removing / changing order of NewGRFs |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
223 |
* Changing NewGRF parameters, loading compatible NewGRF |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
224 |
* Changing game mode (scenario editor <-> normal game) |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
225 |
* Loading game saved in a different OTTD / TTDPatch / TTD version |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
226 |
* Running a modified OTTD build |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
227 |
* Changing patch settings affecting NewGRF behaviour (non-networksafe patches) |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
228 |
* Changing landscape (by cheat) |
9704
54123af5f9a5
(svn r13816) -Fix [FS#2150]: check for vehicle length changes outside a depot (callback 0x11) and give a warning about that
smatz
parents:
9558
diff
changeset
|
229 |
* Triggering NewGRF bugs |
9457
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
230 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
231 |
No personal information is stored. |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
232 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
233 |
You can show the gamelog by typing 'gamelog' in the console or by running |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
234 |
OpenTTD in debug mode. |
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
235 |
|
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
8672
diff
changeset
|
236 |
|
0 | 237 |
6.0) Configuration File: |
238 |
---- ------------------- |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
239 |
The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
240 |
.INI format. It's mostly undocumented. Almost all settings can be changed |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
241 |
ingame by using the 'Configure Patches' window. |
0 | 242 |
|
243 |
||
244 |
7.0) Compiling: |
|
245 |
---- ---------- |
|
246 |
Windows: |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
247 |
You need Microsoft Visual Studio .NET. Open the project file |
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
248 |
and it should build automatically. In case you want to build with SDL support |
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
249 |
you need to add WITH_SDL to the project settings. |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
250 |
PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
251 |
to work you need their development files. For best results, download the |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
252 |
openttd-useful.zip file from SourceForge under the Files tab. Put the header |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
253 |
files into your compiler's include/ directory and the library (.lib) files |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
254 |
into the lib/ directory. |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
255 |
For more help with VS see docs/Readme_Windows_MSVC.txt. |
222
b88456001397
(svn r223) -Fix: Const correctness and miscellaneous fixes. Thank you Tron for your diligent fixing of warnings (and some possibly bugs) (Tron)
darkvater
parents:
37
diff
changeset
|
256 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
257 |
You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW. |
0 | 258 |
Please read the Makefile for more information. |
259 |
||
6219
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
260 |
Solaris 10: |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
261 |
You need g++ (version 3 or higher), together with SDL. Installation of |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
262 |
libpng and zlib is recommended. For the first build it is required |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
263 |
to execute "bash configure" first. Note that ./configure does not work |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
264 |
yet. It is likely that you don't have a strip binary, so use the |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
265 |
--disable-strip option in that case. Fontconfig (>2.3.0) and freetype |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
266 |
are optional. "make run" will then run the program. |
343fba5c9a44
(svn r9016) [SunOS] -Fix: Don't use a struct-member that doesn't exist.
celestar
parents:
6168
diff
changeset
|
267 |
|
0 | 268 |
Unix: |
1133
9424bc9132cf
(svn r1634) Update readme: JAM support has been removed, also be more precise which version of SDL is needed to compile
tron
parents:
1125
diff
changeset
|
269 |
OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake". |
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
270 |
However, for the first build one has to do a "./configure" first. |
1133
9424bc9132cf
(svn r1634) Update readme: JAM support has been removed, also be more precise which version of SDL is needed to compile
tron
parents:
1125
diff
changeset
|
271 |
Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD. |
0 | 272 |
|
2937
0d086e061a85
(svn r3493) -docs: [OSX] forgot to add Cocoa drivers and universal binaries as supported (thanks to Tobin for noticing)
bjarni
parents:
2936
diff
changeset
|
273 |
MacOS X: |
0d086e061a85
(svn r3493) -docs: [OSX] forgot to add Cocoa drivers and universal binaries as supported (thanks to Tobin for noticing)
bjarni
parents:
2936
diff
changeset
|
274 |
Use "make" or Xcode (which will then call make for you) |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
275 |
This will give you a binary for your CPU type (PPC/Intel) |
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
276 |
However, for the first build one has to do a "./configure" first. |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
277 |
To make a universal binary type "./configure --enabled-universal" |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
278 |
instead of "./configure". |
0 | 279 |
|
280 |
BeOS: |
|
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
281 |
Use "make", but do a "./configure" before the first build. |
0 | 282 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
283 |
FreeBSD: |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
284 |
You need the port devel/sdl12 for a non-dedicated build. |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
285 |
graphics/png is optional for screenshots in the PNG format. |
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
286 |
Use "gmake", but do a "./configure" before the first build. |
0 | 287 |
|
6673
edf10cfdee17
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138
parents:
6514
diff
changeset
|
288 |
OpenBSD: |
edf10cfdee17
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138
parents:
6514
diff
changeset
|
289 |
Use "gmake", but do a "./configure" before the first build. |
edf10cfdee17
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138
parents:
6514
diff
changeset
|
290 |
Note that you need the port devel/sdl to compile OpenTTD. |
edf10cfdee17
(svn r9904) -Codechange [FS#798]: Add OpenBSD support to configure (matthias)
peter1138
parents:
6514
diff
changeset
|
291 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
292 |
MorphOS: |
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
293 |
Use "make". However, for the first build one has to do a "./configure" first. |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
294 |
Note that you need the MorphOS SDK, latest libnix updates (else C++ parts of |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
295 |
OpenTTD will not build) and the powersdl.library SDK. Optionally libz, |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
296 |
libpng and freetype2 developer files. |
0 | 297 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
298 |
OS/2: |
7045
5d5306f074db
(svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge
parents:
6744
diff
changeset
|
299 |
A comprehensive GNU build environment is required to build the OS/2 version. |
5d5306f074db
(svn r10310) -Fix: Trunk can now be built on OS/2 :)
orudge
parents:
6744
diff
changeset
|
300 |
See the docs/Readme_OS2.txt file for more information. |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
301 |
|
10385
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
302 |
DOS: |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
303 |
A build environment with DJGPP is needed as well as libraries such as |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
304 |
Allegro, zlib and libpng, which all can be downloaded from the DJGPP |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
305 |
website. Compilation is straight forward: use make, but do a "./configure" |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
306 |
before the first build. The build binary will need cwsdpmi.exe to be in |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
307 |
the same directory as the openttd executable. cwsdpmi.exe can be found in |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
308 |
the os/dos subdirectory. If you compile with stripping turned on a binary |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
309 |
will be generated that does not need cwsdpmi.exe by adding the cswdstub.exe |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
310 |
to the created OpenTTD binary. |
4f9838649c7f
(svn r14636) -Add: DOS port of OpenTTD, without network support though.
rubidium
parents:
9945
diff
changeset
|
311 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
312 |
|
0 | 313 |
8.0) Translating: |
314 |
---- ------------------- |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
315 |
See http://www.openttd.org/translating.php for up-to-date information. |
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
316 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
317 |
The use of the online Translator service, located at |
4785 | 318 |
http://translator2.openttd.org/, is highly encouraged. For a username/password |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
319 |
combo you should contact the development team, either by mail, IRC or the |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
320 |
forums. The system is straightforward to use, and if you have any problems, |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
321 |
read the online help located there. |
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
322 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
323 |
If for some reason the website is down for a longer period of time, the |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
324 |
information below might be of help. |
0 | 325 |
|
326 |
8.1) Guidelines: |
|
327 |
---- ------------------- |
|
328 |
Here are some translation guidelines which you should follow closely. |
|
329 |
||
3122
e87cff55ff8c
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater
parents:
2946
diff
changeset
|
330 |
* Please contact the development team before beginning the translation |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
331 |
process! This avoids double work, as someone else may have already |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
332 |
started translating to the same language. |
0 | 333 |
|
334 |
8.2) Translation: |
|
335 |
---- ------------------- |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
336 |
So, now that you've notified the development team about your intention to |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
337 |
translate (You did, right? Of course you did.) you can pick up english.txt |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
338 |
(found in the SVN repository under /lang) and translate. |
0 | 339 |
|
340 |
You must change the first two lines of the file appropriately: |
|
341 |
||
342 |
##name English-Name-Of-Language |
|
343 |
##ownname Native-Name-Of-Language |
|
344 |
||
345 |
Note: Do not alter the following parts of the file: |
|
346 |
||
347 |
* String identifiers (the first word on each line) |
|
348 |
* Parts of the strings which are in curly braces (such as {STRING}) |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
349 |
* Lines beginning with ## (such as ##id), other than the first two lines of |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
350 |
the file |
0 | 351 |
|
352 |
8.3) Previewing: |
|
353 |
---- ------------------- |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
354 |
In order to view the translation in the game, you need to compile your language |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
355 |
file with the strgen utility, which is now bundled with the game. |
0 | 356 |
|
357 |
strgen is a command-line utility. It takes the language filename as parameter. |
|
358 |
Example: |
|
359 |
||
360 |
strgen lang/german.txt |
|
361 |
||
362 |
This results in compiling german.txt and produces another file named german.lng. |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
363 |
Any missing strings are replaced with the English strings. Note that it looks |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
364 |
for english.txt in the lang subdirectory, which is where your language file |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
365 |
should also be. |
0 | 366 |
|
367 |
That's all! You should now be able to select the language in the game options. |
|
368 |
||
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
369 |
9.0) Troubleshooting |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
370 |
---- --------------- |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
371 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
372 |
To see all startup options available to you, start OpenTTD with the |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
373 |
"./openttd -h" option. This might help you tweak some of the settings. |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
374 |
|
3122
e87cff55ff8c
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater
parents:
2946
diff
changeset
|
375 |
If the game is acting strange and you feel adventurous you can try the |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
376 |
"-d [[<name>]=[<level>]" flag, where the higher levels will give you more |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
377 |
debugging output. The "name" variable can help you to display only some type of |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
378 |
debugging messages. This is mostly undocumented so best is to look in the |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
379 |
source code file debug.c for the various debugging types. For more information |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
380 |
look at http://wiki.openttd.org/index.php/Command_line. |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
381 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
382 |
The most frequent problem is missing data files. Don't forget to put all GRF |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
383 |
files from TTD into your data/ folder including sample.cat! |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
384 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
385 |
Under Windows 98 and lower it is impossible to use a dedicated server; it will |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
386 |
fail to start. Perhaps this is for the better because those OS's are not known |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
387 |
for their stability. |
0 | 388 |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
389 |
With the added support for font-based text selecting a non-latin language will |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
390 |
result in garbage (lots of '?') shown on screen. Please open your configuration |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
391 |
file and add a desired font for small/medium/-and large_font. This can be a font |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
392 |
name like "Tahoma" or a path to a font. |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
393 |
|
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
394 |
Any NewGRF file used in a game is stored inside the savegame and will refuse |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
395 |
to load if you don't have that grf file available. A list of missing files |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
396 |
will be output to the console at the moment, so use the '-d' flag (on windows) |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
397 |
to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/) |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
398 |
put them in the data/ folder and you're set to go. |
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
399 |
|
0 | 400 |
X.X) Credits: |
401 |
---- -------- |
|
1124 | 402 |
The OpenTTD team (in alphabetical order): |
8059
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
403 |
Jean-Francois Claeys (Belugas) - GUI, newindustries and more |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
404 |
Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
405 |
Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework |
9945
3efbd07a3733
(svn r14100) -Fix(r14099): Who reads readme.txt files anyway?. Same work as previous commit.
belugas
parents:
9704
diff
changeset
|
406 |
Victor Fischer (Celestar) - Programming everywhere you need him to |
3efbd07a3733
(svn r14100) -Fix(r14099): Who reads readme.txt files anyway?. Same work as previous commit.
belugas
parents:
9704
diff
changeset
|
407 |
Christoph Elsenhans (frosch) - General coding |
8059
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
408 |
Loïc Guilloux (glx) - General coding |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
409 |
Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
410 |
Jonathan Coome (Maedhros) - High priest of the newGRF Temple |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
411 |
Attila Bán (MiHaMiX) - WebTranslator, Nightlies, Wiki and bugtracker host |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
412 |
Owen Rudge (orudge) - Forum host, OS/2 port |
8184
01844847278c
(svn r11747) -Change: Return of the prodigal son (or something). Little update (but highly noticed) on the OpenTTD Team
belugas
parents:
8059
diff
changeset
|
413 |
Peter Nelson (peter1138) - Spiritual descendant from newGRF gods |
8059
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
414 |
Remko Bijker (Rubidium) - Lead coder and way more |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
415 |
Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
416 |
Zdenek Sojka (SmatZ) - Bug finder and fixer |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
417 |
|
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
418 |
Inactive Developers: |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
419 |
Tamás Faragó (Darkvater) - Ex-Lead coder |
1125 | 420 |
Christoph Mallon (Tron) - Programmer, code correctness police |
421 |
||
422 |
Retired Developers: |
|
8059
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
423 |
Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) |
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
424 |
Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) |
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
425 |
Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) |
7859
5595fe36e31b
(svn r11409) -Update: as of now, I am a retired Developer, so mark me as such
truelight
parents:
7686
diff
changeset
|
426 |
Patric Stout (TrueLight) - Programmer, webhoster (0.3 - pre0.6) |
799
15f525805017
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
427 |
|
0 | 428 |
Thanks to: |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
429 |
Josef Drexler - For his great work on TTDPatch. |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
430 |
Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
431 |
Petr Baudis (pasky) - Many patches, newgrf support, etc. |
8059
0dbe702b7096
(svn r11620) -Change: Some are going, some are coming, some we do not know exactly. Little update on the OpenTTD Team
belugas
parents:
8052
diff
changeset
|
432 |
Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
433 |
Stefan Meißner (sign_de) - For his work on the console |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
434 |
Mike Ragsdale - OpenTTD installer |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
435 |
Cian Duffy (MYOB) - BeOS port / manual writing |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
436 |
Christian Rosentreter (tokai) - MorphOS / AmigaOS port |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
437 |
Richard Kempton (RichK67) - Additional airports, initial TGP implementation |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
438 |
Michael Blunck - For revolutionizing TTD with awesome graphics |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
439 |
George - Canal graphics |
6691
f9adbb0be102
(svn r9923) -Add: support for Action 0 Road vehicles, property 1C, bit 0.
rubidium
parents:
6673
diff
changeset
|
440 |
David Dallaston (Pikka) - Tram tracks |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
441 |
All Translators - For their support to make OpenTTD a truly international game |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
442 |
Bug Reporters - Thanks for all bug reports |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
443 |
Chris Sawyer - For an amazing game! |