1

OpenTTD README

     2

Last updated:    $LastChangedDate: 2004-12-24 00:25:11 +0100 $

     3

Release version: 0.3.6

     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

9.0) Troubleshooting

    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

    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

    38

on irc.freenode.net).

    39

    40

The OpenTTD homepage is http://www.openttd.org/.

    41

    43

http://www.tt-forums.net/index.php?c=20

    44

    45

    46

2.1) Reporting Bugs:

    47

---- ---------------

    48

To report a bug, please create a SourceForge account and follow the bugs

    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

    54

The SourceForge project page URL is: http://sourceforge.net/projects/openttd/

    55

Click on "Bugs" to see the bug tracker.

    56

    57

Please include the following information in your bug report:

    58

        - OpenTTD version (PLEASE test the latest SVN/daily build)

    59

        - Bug details, including instructions how to reproduce it

    60

        - Platform and compiler (Win32, Linux, FreeBSD, ...)

    62

        - If this bug only occurred recently please note the last

    63

          version without the bug and the first version including

    64

          the bug. That way we can fix it quicker by looking at the

    65

          changes made.

    66

    67

    68

3.0) Supported Platforms:

    69

---- --------------------

    70

OpenTTD has been ported to several platforms and operating systems. It shouldn't

    71

be very difficult to port it to a new platform. The currently working platforms

    72

are:

    73

    74

	Windows - Win32 GDI (faster) or SDL

    75

	Linux - SDL

    76

	FreeBSD - SDL

    78

	BeOS - SDL

    79

	MorphOS - SDL

    81

    82

    83

4.0) Running OpenTTD:

    84

---- ----------------

    85

    86

Before you run OpenTTD, you need to put the game's datafiles into the data/

    87

subdirectory. You need the following files from the original version

    88

of TTD as OpenTTD makes use of the original TTD artwork.

    89

    90

List of the required files:

    91

sample.cat

    92

trg1r.grf

    93

trgcr.grf

    94

trghr.grf

    95

trgir.grf

    96

trgtr.grf

    97

    98

(Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF,

    99

TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with 

   100

the DOS graphics remain. E.g. the autorail button in the rail toolbar doesn't 

   101

look as nice as with the Windows graphics.)

   102

   103

If you want music you need to copy the gm/ folder from Windows TTD into your

   104

OpenTTD folder, not your data folder.

   105

   106

You can change the data path (which contains savegames as well) in Makefile.config

   107

by setting DATA_DIR_PREFIX and USE_HOMEDIR.

   108

   109

   110

5.0) OpenTTD features:

   111

---- -----------------

   112

   113

OpenTTD has a lot of features going beyond the original TTD emulation.

   117

features known from TTDPatch (http://www.ttdpatch.net/).

   118

   119

Several important non-standard controls:

   120

   121

* Use Ctrl to place presignals

   123

* Ingame console. More information at http://wiki.openttd.org/index.php/OpenTTDDevBlackBook

   124

   125

   126

6.0) Configuration File:

   127

---- -------------------

   129

.INI format. It's mostly undocumented. Almost all settings can be changed ingame by

   131

   132

   133

7.0) Compiling:

   134

---- ----------

   135

Windows:

   136

  You need Microsoft Visual Studio 6 or .NET. Open the project file

   137

  and it should build automatically. In case you want to build with SDL support

   138

  you need to add WITH_SDL to the project settings.

   139

  PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these to

   142

  include/ directory and the library (.lib) files into the lib/ directory. For more help

   143

  with VS6 see docs/Readme_Windows_MSVC6.0.txt.

   144

   146

  Please read the Makefile for more information.

   147

   148

Unix:

   149

  OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake".

   150

  Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD.

   151

  (see also docs/Readme_Mandrake_Linux.txt)

   152

   153

MacOS:

   154

  Use "make".

   155

   156

BeOS:

   157

  Use "make".

   158

   160

  Use "gmake".

   161

   163

  Use "make". Note that you need the MorphOS SDK and the

   164

  powersdl.library SDK.

   165

   171

8.0) Translating:

   172

---- -------------------

   173

See http://www.openttd.org/translating.php for up-to-date information.

   174

   179

   180

If for some reason the website is down for a longer period of time, the information below

   181

might be of help.

   182

   183

8.1) Guidelines:

   184

---- -------------------

   185

Here are some translation guidelines which you should follow closely.

   186

   187

    * Please contact the development team before begining the translation process!

   188

      This avoids double work, as someone else may have already started translating to the same language.

   189

    * Translators must use the charater set ISO 8859-15.

   190

      Otherwise, some characters will not display correctly in the game.

   194

   195

8.2) Translation:

   196

---- -------------------

   197

So, now that you've notified the development team about your intention to translate

   198

(You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository

   199

under /lang) and translate.

   200

   201

You must change the first two lines of the file appropriately:

   202

   203

##name English-Name-Of-Language

   204

##ownname Native-Name-Of-Language

   205

   206

Note: Do not alter the following parts of the file:

   207

   208

    * String identifiers (the first word on each line)

   209

    * Parts of the strings which are in curly braces (such as {STRING})

   210

    * Lines beginning with ## (such as ##id), other than the first two lines of the file

   211

   212

8.3) Previewing:

   213

---- -------------------

   214

In order to view the translation in the game, you need to compile your language file

   215

with the strgen utility, which is now bundled with the game.

   216

   217

strgen is a command-line utility. It takes the language filename as parameter.

   218

Example:

   219

   220

strgen lang/german.txt

   221

   222

This results in compiling german.txt and produces another file named german.lng.

   224

in the lang subdirectory, which is where your language file should also be.

   225

   226

That's all! You should now be able to select the language in the game options.

   227

   228

9.0) Troubleshooting

   231

To see all startup options available to you, start OpenTTD with the "./openttd -h"

   232

option. This might help you tweak some of the settings.

   233

   243

Another, less frequent problem is the game refusing to run when you don't have a

   245

the command line option: "./openttd -s null -m null". This will disable both sound

   246

and music.

   249

start. Perhaps this is for the better because those OS's are not known for their stability.

   250

   251

X.X) Credits:

   252

---- --------

   253

The OpenTTD team (in alphabetical order):

   255

  Victor Fischer (Celestar)      - Programming everywhere you need him to

   256

  Tamas Faragó (Darkvater)       - Lead programmer

   257

  Kerekes Miham (MiHaMiX)        - Maintainer of translator service, and host of nightlies

   259

  Christoph Mallon (Tron)        - Programmer, code correctness police

   260

  Patric Stout (TrueLight)       - Programmer, network guru, SVN-repository and website host

   261

   262

Retired Developers:

   263

  Dominik Scherer (dominik81)    - Lead programmer, GUI expert (0.3.0 - 0.3.6)

   264

  Ludvig Strigeus (ludde)        - OpenTTD author, main coder (0.1 - 0.3.3)

   265

  Serge Paquet (vurlix)          - Assistant project manager, coder (0.1 - 0.3.3)

   266

   267

Thanks to:

   268

  Josef Drexler - For his great work on TTDPatch.

   269

  Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations)

   270

  Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite

   271

  Petr Baudis (pasky) - Many patches, newgrf support, etc.

   272

  Stefan Meißner (sign_de) - For his work on the console

   273

  Mike Ragsdale - OpenTTD installer

   274

  Cian Duffy (MYOB) - BeOS port / manual writing

   275

  Christian Rosentreter (tokaiz) - MorphOS / AmigaOS port

   276

  Michael Blunck - For revolutionizing TTD with awesome graphics

   277

  George - Canal graphics

   278

  All Translators - For their support to make OpenTTD a truly international game

   279

  Bug Reporters - Thanks for all bug reports

   280

  Chris Sawyer - For an amazing game!