author | Darkvater |
Fri, 23 Feb 2007 12:56:10 +0000 | |
changeset 6124 | 9f822ae6c086 |
parent 5965 | 4cb95cd1fa05 |
child 6168 | 91640fd48876 |
permissions | -rw-r--r-- |
0 | 1 |
OpenTTD README |
5965
4cb95cd1fa05
(svn r8642) -Merge: Release changes from the 0.5 branch back to trunk. This ensures an updated changelog, readme, etc.
rubidium
parents:
5726
diff
changeset
|
2 |
Last updated: 2007-02-08 |
4cb95cd1fa05
(svn r8642) -Merge: Release changes from the 0.5 branch back to trunk. This ensures an updated changelog, readme, etc.
rubidium
parents:
5726
diff
changeset
|
3 |
Release version: 0.5.0-RC5 |
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 |
|
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
21 |
9.0) Troubleshooting |
0 | 22 |
X.X) Credits |
23 |
||
24 |
||
25 |
1.0) About: |
|
26 |
---- ------ |
|
27 |
OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally |
|
28 |
written by Chris Sawyer. It attempts to mimic the original game as closely |
|
29 |
as possible while extending it with new features. |
|
30 |
||
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
31 |
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
|
32 |
more information, see the file 'COPYING'. |
0 | 33 |
|
34 |
2.0) Contacting: |
|
35 |
---- ---------- |
|
36 |
The easiest way to contact the OpenTTD team is by submitting bug reports or |
|
37 |
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
|
38 |
on irc.oftc.net). |
0 | 39 |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
40 |
The OpenTTD homepage is http://www.openttd.org/. |
0 | 41 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
42 |
You can also find the OpenTTD forums at |
0 | 43 |
http://www.tt-forums.net/index.php?c=20 |
44 |
||
45 |
||
46 |
2.1) Reporting Bugs: |
|
47 |
---- --------------- |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
48 |
To report a bug, please create a Flyspray account and follow the bugs |
0 | 49 |
link from our homepage. Please make sure the bug is reproducible and |
50 |
still occurs in the latest daily build or the current SVN version. Also |
|
51 |
please look through the existing bug reports briefly to see whether the bug |
|
52 |
is not already known. |
|
53 |
||
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
54 |
The Flyspray project page URL is: http://bugs.openttd.org/ |
0 | 55 |
|
56 |
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
|
57 |
- OpenTTD version (PLEASE test the latest SVN/nightly build) |
0 | 58 |
- Bug details, including instructions how to reproduce it |
59 |
- Platform and compiler (Win32, Linux, FreeBSD, ...) |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
60 |
- Attach a saved game or a screenshot if possible |
0 | 61 |
- If this bug only occurred recently please note the last |
62 |
version without the bug and the first version including |
|
63 |
the bug. That way we can fix it quicker by looking at the |
|
64 |
changes made. |
|
65 |
||
66 |
||
67 |
3.0) Supported Platforms: |
|
68 |
---- -------------------- |
|
69 |
OpenTTD has been ported to several platforms and operating systems. It shouldn't |
|
70 |
be very difficult to port it to a new platform. The currently working platforms |
|
71 |
are: |
|
72 |
||
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
73 |
BeOS - SDL |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
74 |
FreeBSD - SDL |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
75 |
Linux - SDL |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
76 |
MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary) |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
77 |
MorphOS - SDL |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
78 |
OS/2 - SDL |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
79 |
Windows - Win32 GDI (faster) or SDL |
0 | 80 |
|
81 |
||
82 |
4.0) Running OpenTTD: |
|
83 |
---- ---------------- |
|
84 |
||
85 |
Before you run OpenTTD, you need to put the game's datafiles into the data/ |
|
614
b96f987dbf80
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
86 |
subdirectory. You need the following files from the original version |
0 | 87 |
of TTD as OpenTTD makes use of the original TTD artwork. |
88 |
||
89 |
List of the required files: |
|
90 |
sample.cat |
|
91 |
trg1r.grf |
|
92 |
trgcr.grf |
|
93 |
trghr.grf |
|
94 |
trgir.grf |
|
95 |
trgtr.grf |
|
96 |
||
799
15f525805017
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
97 |
(Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF, |
2748
21bbb96a6467
(svn r3293) - Miscellaneous: add peter1138 as developer
Darkvater
parents:
2401
diff
changeset
|
98 |
TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with |
21bbb96a6467
(svn r3293) - Miscellaneous: add peter1138 as developer
Darkvater
parents:
2401
diff
changeset
|
99 |
the DOS graphics remain. E.g. the autorail button in the rail toolbar doesn't |
961 | 100 |
look as nice as with the Windows graphics.) |
0 | 101 |
|
799
15f525805017
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
102 |
If you want music you need to copy the gm/ folder from Windows TTD into your |
614
b96f987dbf80
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
103 |
OpenTTD folder, not your data folder. |
b96f987dbf80
(svn r1038) Feature: OpenTTD runs with the grf files of the DOS version
dominik
parents:
504
diff
changeset
|
104 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
105 |
You can change the data path (which contains savegames as well) in |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
106 |
Makefile.config by setting DATA_DIR_PREFIX and USE_HOMEDIR. |
0 | 107 |
|
108 |
||
109 |
5.0) OpenTTD features: |
|
110 |
---- ----------------- |
|
111 |
||
112 |
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
|
113 |
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
|
114 |
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
|
115 |
controlled through the Configure Patches dialog. We also implement some |
0 | 116 |
features known from TTDPatch (http://www.ttdpatch.net/). |
117 |
||
118 |
Several important non-standard controls: |
|
119 |
||
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
120 |
* Use Ctrl to place semaphore signals |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
121 |
* Ctrl-D toggles double mode in the Windows version |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
122 |
* Ingame console. More information at |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
123 |
http://wiki.openttd.org/index.php/Console |
0 | 124 |
|
125 |
||
126 |
6.0) Configuration File: |
|
127 |
---- ------------------- |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
128 |
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
|
129 |
.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
|
130 |
ingame by using the 'Configure Patches' window. |
0 | 131 |
|
132 |
||
133 |
7.0) Compiling: |
|
134 |
---- ---------- |
|
135 |
Windows: |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
136 |
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
|
137 |
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
|
138 |
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
|
139 |
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
|
140 |
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
|
141 |
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
|
142 |
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
|
143 |
into the lib/ directory. |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
144 |
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
|
145 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
146 |
You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW. |
0 | 147 |
Please read the Makefile for more information. |
148 |
||
149 |
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
|
150 |
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
|
151 |
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
|
152 |
Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD. |
0 | 153 |
|
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
|
154 |
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
|
155 |
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
|
156 |
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
|
157 |
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
|
158 |
To make a universal binary type "./configure --enabled-universal" |
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
159 |
instead of "./configure". |
0 | 160 |
|
161 |
BeOS: |
|
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
162 |
Use "make", but do a "./configure" before the first build. |
0 | 163 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
164 |
FreeBSD: |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
165 |
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
|
166 |
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
|
167 |
Use "gmake", but do a "./configure" before the first build. |
0 | 168 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
169 |
MorphOS: |
5475
2e6990a8c7c4
(svn r7759) -Merge: makefile rewrite. This merge features:
rubidium
parents:
5443
diff
changeset
|
170 |
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
|
171 |
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
|
172 |
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
|
173 |
libpng and freetype2 developer files. |
0 | 174 |
|
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
175 |
OS/2: |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
176 |
Open Watcom C/C++ 1.3 or later is required to build the OS/2 version. See the |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
177 |
docs/Readme_OS2.txt file for more information. |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
178 |
|
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
179 |
|
0 | 180 |
8.0) Translating: |
181 |
---- ------------------- |
|
250
733e18ca6e93
(svn r251) -Project ready for 0.3.4 release. Updated installer, readme and fileinformation
darkvater
parents:
222
diff
changeset
|
182 |
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
|
183 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
184 |
The use of the online Translator service, located at |
4785 | 185 |
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
|
186 |
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
|
187 |
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
|
188 |
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
|
189 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
190 |
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
|
191 |
information below might be of help. |
0 | 192 |
|
193 |
8.1) Guidelines: |
|
194 |
---- ------------------- |
|
195 |
Here are some translation guidelines which you should follow closely. |
|
196 |
||
3122
e87cff55ff8c
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater
parents:
2946
diff
changeset
|
197 |
* 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
|
198 |
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
|
199 |
started translating to the same language. |
3122
e87cff55ff8c
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater
parents:
2946
diff
changeset
|
200 |
* Translators must use the character set ISO 8859-15. |
0 | 201 |
Otherwise, some characters will not display correctly in the game. |
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
202 |
* Currently it is not possible to translate into character sets other than |
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
203 |
Latin. |
0 | 204 |
|
205 |
8.2) Translation: |
|
206 |
---- ------------------- |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
207 |
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
|
208 |
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
|
209 |
(found in the SVN repository under /lang) and translate. |
0 | 210 |
|
211 |
You must change the first two lines of the file appropriately: |
|
212 |
||
213 |
##name English-Name-Of-Language |
|
214 |
##ownname Native-Name-Of-Language |
|
215 |
||
216 |
Note: Do not alter the following parts of the file: |
|
217 |
||
218 |
* String identifiers (the first word on each line) |
|
219 |
* 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
|
220 |
* 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
|
221 |
the file |
0 | 222 |
|
223 |
8.3) Previewing: |
|
224 |
---- ------------------- |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
225 |
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
|
226 |
file with the strgen utility, which is now bundled with the game. |
0 | 227 |
|
228 |
strgen is a command-line utility. It takes the language filename as parameter. |
|
229 |
Example: |
|
230 |
||
231 |
strgen lang/german.txt |
|
232 |
||
233 |
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
|
234 |
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
|
235 |
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
|
236 |
should also be. |
0 | 237 |
|
238 |
That's all! You should now be able to select the language in the game options. |
|
239 |
||
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
240 |
9.0) Troubleshooting |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
241 |
---- --------------- |
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
242 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
243 |
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
|
244 |
"./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
|
245 |
|
3122
e87cff55ff8c
(svn r3727) - Fix some typos in the readme and known-bugs text files
Darkvater
parents:
2946
diff
changeset
|
246 |
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
|
247 |
"-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
|
248 |
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
|
249 |
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
|
250 |
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
|
251 |
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
|
252 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
253 |
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
|
254 |
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
|
255 |
|
2401
7e90848c440d
(svn r2927) Fix/remove stale information, line breaks, inform FreeBSD users about the required ports
tron
parents:
2134
diff
changeset
|
256 |
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
|
257 |
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
|
258 |
for their stability. |
0 | 259 |
|
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
260 |
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
|
261 |
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
|
262 |
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
|
263 |
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
|
264 |
|
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
265 |
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
|
266 |
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
|
267 |
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
|
268 |
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
|
269 |
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
|
270 |
|
0 | 271 |
X.X) Credits: |
272 |
---- -------- |
|
1124 | 273 |
The OpenTTD team (in alphabetical order): |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
274 |
Jean-Francois Claeys (Belugas) - In training, not yet specialized |
1734
1a9908670bc4
(svn r2238) - [ 1184377 ] Update to OpenTTD readme (orudge)
Darkvater
parents:
1703
diff
changeset
|
275 |
Bjarni Corfitzen (Bjarni) - Mac OS X port, coder |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
276 |
Matthijs Kooijman (blathijs) - Pathfinder-guru |
1125 | 277 |
Victor Fischer (Celestar) - Programming everywhere you need him to |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
278 |
Tamás Faragó (Darkvater) - Lead programmer |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
279 |
Loïc Guilloux (glx) - In training, not yet specialized |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
280 |
Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) |
1124 | 281 |
Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
282 |
|
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
283 |
Peter Nelson (peter1138) - Spiritual descendant from newgrf gods |
5726
a1592d73615b
(svn r8254) -Merge: Release changes from the 0.5 branch back to trunk. This ensures an updated changelog, readme, et.
Darkvater
parents:
5564
diff
changeset
|
284 |
Remko Bijker (Rubidium) - THE desync hunter |
1125 | 285 |
Christoph Mallon (Tron) - Programmer, code correctness police |
286 |
Patric Stout (TrueLight) - Programmer, network guru, SVN-repository and website host |
|
287 |
||
288 |
Retired Developers: |
|
1703
7e1cdd971cb2
(svn r2207) - Update readme.txt about some windows compilation and troubleshooting running openttd without a soundcard.
Darkvater
parents:
1694
diff
changeset
|
289 |
Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) |
5355
195bce6def67
(svn r7527) -Update appropiate files with release information for 0.5.0-RC1
Darkvater
parents:
4785
diff
changeset
|
290 |
Owen Rudge (orudge) - Contributor, forum host, master server host, OS/2 port (0.1 - 0.4.8) |
1125 | 291 |
Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) |
799
15f525805017
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
292 |
Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) |
15f525805017
(svn r1269) - Updated changelog.txt and readme.txt for 0.3.5
truelight
parents:
614
diff
changeset
|
293 |
|
0 | 294 |
Thanks to: |
5404
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
295 |
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
|
296 |
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
|
297 |
Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
298 |
Petr Baudis (pasky) - Many patches, newgrf support, etc. |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
299 |
Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS) |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
300 |
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
|
301 |
Mike Ragsdale - OpenTTD installer |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
302 |
Cian Duffy (MYOB) - BeOS port / manual writing |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
303 |
Christian Rosentreter (tokai) - MorphOS / AmigaOS port |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
304 |
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
|
305 |
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
|
306 |
George - Canal graphics |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
307 |
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
|
308 |
Bug Reporters - Thanks for all bug reports |
4147522f08f3
(svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents:
5397
diff
changeset
|
309 |
Chris Sawyer - For an amazing game! |