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

X.X) Credits

    22

    23

    24

1.0) About:

    25

---- ------

    26

OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally

    27

written by Chris Sawyer.  It attempts to mimic the original game as closely

    28

as possible while extending it with new features.

    29

    30

    31

2.0) Contacting:

    32

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

    33

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

    34

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

    35

on irc.freenode.net).

    36

    37

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

    38

    39

You can find a forum for OpenTTD at

    40

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

    41

    42

    43

2.1) Reporting Bugs:

    44

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

    45

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

    46

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

    47

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

    48

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

    49

is not already known.

    50

    51

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

    52

Click on "Bugs" to see the bug tracker.

    53

    54

Please include the following information in your bug report:

    55

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

    56

        - Bug details, including instructions how to reproduce it

    57

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

    58

        - Attach a save game or a screenshot if possible

    59

        - If this bug only occurred recently please note the last

    60

          version without the bug and the first version including

    61

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

    62

          changes made.

    63

    64

    65

3.0) Supported Platforms:

    66

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

    67

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

    68

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

    69

are:

    70

    71

	Windows - Win32 GDI (faster) or SDL

    72

	Linux - SDL

    73

	FreeBSD - SDL

    74

	MacOS - SDL

    75

	BeOS - SDL

    76

	MorphOS - SDL

    77

    78

    79

4.0) Running OpenTTD:

    80

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

    81

    82

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

    83

subdirectory. You need the following files from the original version

    84

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

    85

    86

List of the required files:

    87

sample.cat

    88

trg1r.grf

    89

trgcr.grf

    90

trghr.grf

    91

trgir.grf

    92

trgtr.grf

    93

    94

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

    95

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

    96

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

    97

look as nice as with the Windows graphics.)

    98

    99

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

   100

OpenTTD folder, not your data folder.

   101

   102

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

   103

by setting DATA_DIR_PREFIX and USE_HOMEDIR.

   104

   105

   106

5.0) OpenTTD features:

   107

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

   108

   109

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

   110

Currently there is unfortunately no comprehensive list of features. You could

   111

check the features list on the web, and some optional features can be

   112

controlled through the Configure patches dialog. We also implement some

   113

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

   114

   115

Several important non-standard controls:

   116

   117

* Use Ctrl to place presignals

   118

* Ctrl-d toggles double mode on win32

   119

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

   120

   121

   122

6.0) Configuration File:

   123

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

   124

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

   125

.INI format. It's mostly undocumented.

   126

   127

   128

7.0) Compiling:

   129

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

   130

Windows:

   131

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

   132

  and it should build automatically. In case you don't build with SDL,

   133

  you need to remove WITH_SDL from the project settings.

   134

  (see also docs/Readme_Windows_MSVC6.0.txt)

   135

   136

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

   137

  Please read the Makefile for more information.

   138

   139

Unix:

   140

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

   141

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

   142

  (see also docs/Readme_Mandrake_Linux.txt)

   143

   144

MacOS:

   145

  Use "make".

   146

   147

BeOS:

   148

  Use "make".

   149

   150

FreeBSD

   151

  Use "gmake".

   152

   153

MorphOS

   154

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

   155

  powersdl.library SDK.

   156

   157

8.0) Translating:

   158

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

   159

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

   160

   161

The use of the online Translator service, located at http://translator.openttd.org.

   162

For a username password combo you should contact the development team, either by mail, irc

   163

or the forums. The system is straight-forward to use, if you have any troubles, read the

   164

online help located there.

   165

   166

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

   167

might be of help.

   168

   169

8.1) Guidelines:

   170

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

   171

Here are some translation guidelines which you should follow closely.

   172

   173

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

   174

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

   175

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

   176

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

   177

   178

8.2) Translation:

   179

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

   180

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

   181

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

   182

under /lang) and translate.

   183

   184

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

   185

   186

##name English-Name-Of-Language

   187

##ownname Native-Name-Of-Language

   188

   189

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

   190

   191

    * String identifiers (the first word on each line)

   192

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

   193

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

   194

   195

8.3) Previewing:

   196

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

   197

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

   198

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

   199

   200

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

   201

Example:

   202

   203

strgen lang/german.txt

   204

   205

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

   206

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

   207

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

   208

   209

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

   210

   211

   212

X.X) Credits:

   213

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

   214

The OpenTTD team (in alphabetical order):

   216

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

   217

  Tamas Faragó (Darkvater)       - Lead programmer

   218

  Dominik Scherer (dominik81)    - Lead programmer

   219

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

   220

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

   221

  Christoph Mallon (Tron)        - Programmer, code correctness police

   222

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

   223

   224

Retired Developers:

   225

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

   226

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

   227

   228

Thanks to:

   229

  Josef Drexler - For his great work on TTDPatch.

   230

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

   231

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

   232

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

   233

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

   234

  Mike Ragsdale - OpenTTD installer

   235

  Cian Duffy (MYOB) - BeOS port / manual writing

   236

  Christian Rosentreter (tokaiz) - MorphOS / AmigaOS port

   237

  Michael Blunck - For revolutionizing TTD with awesome graphics

   238

  George - Canal graphics

   239

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

   240

  Bug Reporters - Thanks for all bug reports

   241

  Chris Sawyer - For an amazing game!