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

    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

    31

    32

2.0) Contacting:

    33

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

    34

The easiest way to contact the OpenTTD team is by submitting bug reports or

    35

posting comments in our forums. You can also chat with us on IRC (#openttd

    36

on irc.freenode.net).

    37

    38

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

    39

    40

You can find a forum for OpenTTD at

    41

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

    42

    43

    44

2.1) Reporting Bugs:

    45

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

    46

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

    47

link from our homepage. Please make sure the bug is reproducible and

    48

still occurs in the latest daily build or the current SVN version. Also

    49

please look through the existing bug reports briefly to see whether the bug

    50

is not already known.

    51

    52

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

    53

Click on "Bugs" to see the bug tracker.

    54

    55

Please include the following information in your bug report:

    56

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

    57

        - Bug details, including instructions how to reproduce it

    58

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

    59

        - Attach a save game or a screenshot if possible

    60

        - If this bug only occurred recently please note the last

    61

          version without the bug and the first version including

    62

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

    63

          changes made.

    64

    65

    66

3.0) Supported Platforms:

    67

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

    68

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

    69

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

    70

are:

    71

    72

	Windows - Win32 GDI (faster) or SDL

    73

	Linux - SDL

    74

	FreeBSD - SDL

    76

	BeOS - SDL

    77

	MorphOS - SDL

    78

    79

    80

4.0) Running OpenTTD:

    81

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

    82

    83

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

    84

subdirectory. You need the following files from the original version

    85

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

    86

    87

List of the required files:

    88

sample.cat

    89

trg1r.grf

    90

trgcr.grf

    91

trghr.grf

    92

trgir.grf

    93

trgtr.grf

    94

    95

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

    96

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

    97

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

    98

look as nice as with the Windows graphics.)

    99

   100

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

   101

OpenTTD folder, not your data folder.

   102

   103

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

   104

by setting DATA_DIR_PREFIX and USE_HOMEDIR.

   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

   120

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

   121

   122

   123

6.0) Configuration File:

   124

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

   125

The configuration file for OpenTTD (openttd.cfg) is in a simple windows-like

   128

   129

   130

7.0) Compiling:

   131

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

   132

Windows:

   133

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

   141

   142

  You can also build it using the Makefile with MSys/MingW or Cygwin/MingW.

   143

  Please read the Makefile for more information.

   144

   145

Unix:

   146

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

   147

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

   148

  (see also docs/Readme_Mandrake_Linux.txt)

   149

   150

MacOS:

   151

  Use "make".

   152

   153

BeOS:

   154

  Use "make".

   155

   156

FreeBSD

   157

  Use "gmake".

   158

   159

MorphOS

   160

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

   161

  powersdl.library SDK.

   162

   163

8.0) Translating:

   164

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

   165

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

   166

   171

   172

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

   173

might be of help.

   174

   175

8.1) Guidelines:

   176

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

   177

Here are some translation guidelines which you should follow closely.

   178

   179

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

   180

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

   181

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

   182

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

   186

   187

8.2) Translation:

   188

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

   189

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

   190

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

   191

under /lang) and translate.

   192

   193

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

   194

   195

##name English-Name-Of-Language

   196

##ownname Native-Name-Of-Language

   197

   198

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

   199

   200

    * String identifiers (the first word on each line)

   201

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

   202

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

   203

   204

8.3) Previewing:

   205

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

   206

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

   207

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

   208

   209

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

   210

Example:

   211

   212

strgen lang/german.txt

   213

   214

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

   215

Any missing strings are replaced with the english strings. Note that it looks for english.txt

   216

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

   217

   218

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

   219

   237

   238

X.X) Credits:

   239

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

   240

The OpenTTD team (in alphabetical order):

   241

  Bjarni Corfitzen (Bjarni)      - MacOSX port, coder

   242

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

   243

  Tamas Faragó (Darkvater)       - Lead programmer

   244

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

   245

  Owen Rudge (orudge)            - Contributor, forum host, masterserver host

   246

  Christoph Mallon (Tron)        - Programmer, code correctness police

   247

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

   248

   249

Retired Developers:

   251

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

   252

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

   253

   254

Thanks to:

   255

  Josef Drexler - For his great work on TTDPatch.

   256

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

   257

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

   258

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

   259

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

   260

  Mike Ragsdale - OpenTTD installer

   261

  Cian Duffy (MYOB) - BeOS port / manual writing

   262

  Christian Rosentreter (tokaiz) - MorphOS / AmigaOS port

   263

  Michael Blunck - For revolutionizing TTD with awesome graphics

   264

  George - Canal graphics

   265

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

   266

  Bug Reporters - Thanks for all bug reports

   267

  Chris Sawyer - For an amazing game!