author | truelight |
Thu, 23 Dec 2004 23:32:07 +0000 | |
changeset 799 | 56e334cb4d31 |
parent 614 | e016770cb781 |
child 961 | 26fdd7e62075 |
permissions | -rw-r--r-- |
0 | 1 |
OpenTTD README |
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
2 |
Last updated: $LastChangedDate: 2004-12-24 00:25:11 +0100 $ |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
3 |
Release version: 0.3.5 |
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 |
|
13 |
4.0) Running OpenTTD |
|
14 |
5.0) OpenTTD features |
|
15 |
6.0) Configuration File |
|
16 |
7.0) Compiling |
|
17 |
8.0) Translating |
|
18 |
* 8.1 Guidelines |
|
19 |
* 8.2 Translation |
|
20 |
* 8.3 Previewing |
|
21 |
X.X) Credits |
|
22 |
||
23 |
||
24 |
1.0) About: |
|
25 |
---- ------ |
|
26 |
OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally |
|
27 |
written by Chris Sawyer. It attempts to mimic the original game as closely |
|
28 |
as possible while extending it with new features. |
|
29 |
||
30 |
||
31 |
2.0) Contacting: |
|
32 |
---- ---------- |
|
33 |
The easiest way to contact the OpenTTD team is by submitting bug reports or |
|
34 |
posting comments in our forums. You can also chat with us on IRC (#openttd |
|
35 |
on irc.freenode.net). |
|
36 |
||
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
37 |
The OpenTTD homepage is http://www.openttd.org/. |
0 | 38 |
|
39 |
You can find a forum for OpenTTD at |
|
40 |
http://www.tt-forums.net/index.php?c=20 |
|
41 |
||
42 |
||
43 |
2.1) Reporting Bugs: |
|
44 |
---- --------------- |
|
45 |
To report a bug, please create a SourceForge account and follow the bugs |
|
46 |
link from our homepage. Please make sure the bug is reproducible and |
|
47 |
still occurs in the latest daily build or the current SVN version. Also |
|
48 |
please look through the existing bug reports briefly to see whether the bug |
|
49 |
is not already known. |
|
50 |
||
51 |
The SourceForge project page URL is: http://sourceforge.net/projects/openttd/ |
|
52 |
Click on "Bugs" to see the bug tracker. |
|
53 |
||
54 |
Please include the following information in your bug report: |
|
55 |
- OpenTTD version (PLEASE test the latest SVN/daily build) |
|
56 |
- Bug details, including instructions how to reproduce it |
|
57 |
- Platform and compiler (Win32, Linux, FreeBSD, ...) |
|
58 |
- Attach a save game or a screenshot if possible |
|
59 |
- If this bug only occurred recently please note the last |
|
60 |
version without the bug and the first version including |
|
61 |
the bug. That way we can fix it quicker by looking at the |
|
62 |
changes made. |
|
63 |
||
64 |
||
65 |
3.0) Supported Platforms: |
|
66 |
---- -------------------- |
|
67 |
OpenTTD has been ported to several platforms and operating systems. It shouldn't |
|
68 |
be very difficult to port it to a new platform. The currently working platforms |
|
69 |
are: |
|
70 |
||
71 |
Windows - Win32 GDI (faster) or SDL |
|
72 |
Linux - SDL |
|
73 |
FreeBSD - SDL |
|
74 |
MacOS - SDL |
|
75 |
BeOS - SDL |
|
76 |
MorphOS - SDL |
|
77 |
||
78 |
||
79 |
4.0) Running OpenTTD: |
|
80 |
---- ---------------- |
|
81 |
||
82 |
Before you run OpenTTD, you need to put the game's datafiles into the data/ |
|
614
e016770cb781
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
83 |
subdirectory. You need the following files from the original version |
0 | 84 |
of TTD as OpenTTD makes use of the original TTD artwork. |
85 |
||
86 |
List of the required files: |
|
87 |
sample.cat |
|
88 |
trg1r.grf |
|
89 |
trgcr.grf |
|
90 |
trghr.grf |
|
91 |
trgir.grf |
|
92 |
trgtr.grf |
|
93 |
||
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
94 |
(Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF, |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
95 |
TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. Those filenames have to be uppercase |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
96 |
to be detected correctly. A few minor graphical glitches with the DOS |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
97 |
graphics remain. E.g. the autorail button in the rail toolbar doesn't look |
614
e016770cb781
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
98 |
as nice as with the Windows graphics.) |
0 | 99 |
|
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
100 |
If you want music you need to copy the gm/ folder from Windows TTD into your |
614
e016770cb781
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
101 |
OpenTTD folder, not your data folder. |
e016770cb781
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
102 |
|
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
103 |
You can change the data path (which contains savegames as well) in Makefile.config |
614
e016770cb781
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
104 |
by setting DATA_DIR_PREFIX and USE_HOMEDIR. |
0 | 105 |
|
106 |
||
107 |
5.0) OpenTTD features: |
|
108 |
---- ----------------- |
|
109 |
||
110 |
OpenTTD has a lot of features going beyond the original TTD emulation. |
|
111 |
Currently there is unfortunately no comprehensive list of features. You could |
|
112 |
check the features list on the web, and some optional features can be |
|
113 |
controlled through the Configure patches dialog. We also implement some |
|
114 |
features known from TTDPatch (http://www.ttdpatch.net/). |
|
115 |
||
116 |
Several important non-standard controls: |
|
117 |
||
118 |
* Use Ctrl to place presignals |
|
119 |
* Ctrl-d toggles double mode on win32 |
|
288
6bd97cdf1652
(svn r294) -Fix: autorail always builds rail, instead of occasional rail removal (on pressing hotkey after pressing 'bulldozer')
darkvater
parents:
250
diff
changeset
|
120 |
* Ingame console. More information at http://wiki.openttd.org/index.php/OpenTTDDevBlackBook |
0 | 121 |
|
122 |
||
123 |
6.0) Configuration File: |
|
124 |
---- ------------------- |
|
125 |
The configuration file for OpenTTD (openttd.cfg) is in a simple windows-like |
|
126 |
.INI format. It's mostly undocumented. |
|
127 |
||
128 |
||
129 |
7.0) Compiling: |
|
130 |
---- ---------- |
|
131 |
Windows: |
|
132 |
You need Microsoft Visual Studio 6 or .NET. Open the project file |
|
133 |
and it should build automatically. In case you don't build with SDL, |
|
134 |
you need to remove WITH_SDL from the project settings. |
|
135 |
(see also docs/Readme_Windows_MSVC6.0.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
|
136 |
|
0 | 137 |
You can also build it using the Makefile with MSys/MingW or Cygwin/MingW. |
138 |
Please read the Makefile for more information. |
|
139 |
||
140 |
Unix: |
|
141 |
OpenTTD can be built either with "make" or with "jam". To build with |
|
142 |
"make", just type "make", or "gmake" on non-gnu systems. To build with "jam", |
|
143 |
first run "./configure" and then "jam". Note that you need SDL to compile |
|
144 |
OpenTTD. |
|
145 |
(see also docs/Readme_Mandrake_Linux.txt) |
|
146 |
||
147 |
MacOS: |
|
148 |
Use "make". |
|
149 |
||
150 |
BeOS: |
|
151 |
Use "jam". |
|
152 |
||
153 |
FreeBSD |
|
154 |
Use "gmake". |
|
155 |
||
156 |
MorphOS |
|
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
|
157 |
Use "make". Note that you need the MorphOS SDK and the |
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
|
158 |
powersdl.library SDK. |
0 | 159 |
|
160 |
8.0) Translating: |
|
161 |
---- ------------------- |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
162 |
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
|
163 |
|
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
164 |
The use of the online Translator service, located at http://translator.openttd.org. |
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
165 |
For a username password combo you should contact the development team, either by mail, irc |
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
166 |
or the forums. The system is straight-forward to use, if you have any troubles, read the |
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
167 |
online help located there. |
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
168 |
|
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
169 |
If for some reason the website is down for a longer period of time, the information below |
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
170 |
might be of help. |
0 | 171 |
|
172 |
8.1) Guidelines: |
|
173 |
---- ------------------- |
|
174 |
Here are some translation guidelines which you should follow closely. |
|
175 |
||
176 |
* Please contact the development team before begining the translation process! |
|
177 |
This avoids double work, as someone else may have already started translating to the same language. |
|
504 | 178 |
* Translators must use the charater set ISO 8859-15. |
0 | 179 |
Otherwise, some characters will not display correctly in the game. |
180 |
||
181 |
8.2) Translation: |
|
182 |
---- ------------------- |
|
183 |
So, now that you've notified the development team about your intention to translate |
|
184 |
(You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository |
|
185 |
under /lang) and translate. |
|
186 |
||
187 |
You must change the first two lines of the file appropriately: |
|
188 |
||
189 |
##name English-Name-Of-Language |
|
190 |
##ownname Native-Name-Of-Language |
|
191 |
||
192 |
Note: Do not alter the following parts of the file: |
|
193 |
||
194 |
* String identifiers (the first word on each line) |
|
195 |
* Parts of the strings which are in curly braces (such as {STRING}) |
|
196 |
* Lines beginning with ## (such as ##id), other than the first two lines of the file |
|
197 |
||
198 |
8.3) Previewing: |
|
199 |
---- ------------------- |
|
200 |
In order to view the translation in the game, you need to compile your language file |
|
201 |
with the strgen utility, which is now bundled with the game. |
|
202 |
||
203 |
strgen is a command-line utility. It takes the language filename as parameter. |
|
204 |
Example: |
|
205 |
||
206 |
strgen lang/german.txt |
|
207 |
||
208 |
This results in compiling german.txt and produces another file named german.lng. |
|
209 |
Any missing strings are replaced with the english strings. Note that it looks for english.txt |
|
210 |
in the lang subdirectory, which is where your language file should also be. |
|
211 |
||
212 |
That's all! You should now be able to select the language in the game options. |
|
213 |
||
214 |
||
215 |
X.X) Credits: |
|
216 |
---- -------- |
|
217 |
The OpenTTD team: |
|
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
218 |
Dominik Scherer (dominik81) - Lead coder |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
219 |
Tamas Farago (Darkvater) - Lead coder |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
220 |
Patric Stout (TrueLight) - Coder, network guru, SVN-repository and website host |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
221 |
Owen Rudge (orudge) - Contributor, forum host, masterserver host |
0 | 222 |
Bjarni Corfitzen (Bjarni) - MacOS port |
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
223 |
Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies |
0 | 224 |
Cian Duffy (MYOB) - BeOS port / manual writing |
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
225 |
Christian Rosentreter (tokaiz) - MorphOS / AmigaOS port |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
226 |
Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
227 |
Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
228 |
|
0 | 229 |
Thanks to: |
230 |
Josef Drexler - For his great work on TTDPatch. |
|
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
231 |
Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) |
0 | 232 |
Mike Ragsdale - OpenTTD installer |
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
233 |
Celestar - For his many patches, suggestions and fixes |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
234 |
blathijs - For his many patches, suggestions and code documentation |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
235 |
Tron - For his many patches, suggestions and relentless correcting of the code |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
236 |
Stefan Meißner (sign_de) - For his work on the console |
0 | 237 |
pasky - Many patches, newgrf support, etc. |
238 |
Michael Polnick - Some patches |
|
239 |
Michael Blunck - Nice graphics |
|
240 |
George - Canal graphics |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
241 |
All Translators - For their support to make OpenTTD a truly international game |
799
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
242 |
Bug Reporters - Thanks for all bug reports |
56e334cb4d31
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
243 |
Chris Sawyer - For an amazing game! |