Mercurial > hg > openttd

annotate readme.txt @ 1125:de436fc47e5f draft

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