1

OpenTTD README

     2

Last updated:    2007-09-15

     3

Release version: 0.5.3

     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

    31

OpenTTD is licensed under the GNU General Public License version 2.0. For

    32

more information, see the file 'COPYING'.

    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.oftc.net).

    39

    40

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

    41

    42

You can also find the OpenTTD forums at

    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 Flyspray 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 Flyspray project page URL is: http://bugs.openttd.org/

    55

    56

Please include the following information in your bug report:

    57

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

    58

        - Bug details, including instructions how to reproduce it

    59

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

    60

        - Attach a saved game or a screenshot if possible

    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

    73

  BeOS                 - SDL

    74

  FreeBSD              - SDL

    75

  Linux                - SDL

    76

  MacOS X (universal)  - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary)

    77

  MorphOS              - SDL

    78

  OS/2                 - SDL

    79

  Windows              - Win32 GDI (faster) or SDL

    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/

    86

subdirectory. You need the following files from the original version

    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

    97

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

    98

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

    99

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

   100

look as nice as with the Windows graphics.)

   101

   102

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

   103

OpenTTD folder, not your data folder.

   104

   105

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

   106

Makefile.config by setting DATA_DIR_PREFIX and USE_HOMEDIR.

   107

   108

   109

5.0) OpenTTD features:

   110

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

   111

   112

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

   113

Unfortunately, there is currently no comprehensive list of features, but there

   114

is a basic features list on the web, and some optional features can be

   115

controlled through the Configure Patches dialog. We also implement some

   116

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

   117

   118

Several important non-standard controls:

   119

   120

* Use Ctrl to place semaphore signals

   121

* Ctrl-D toggles double mode in the Windows version

   122

* Ingame console. More information at

   123

  http://wiki.openttd.org/index.php/Console

   124

   125

   126

6.0) Configuration File:

   127

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

   128

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

   129

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

   130

ingame by using the 'Configure Patches' window.

   131

   132

   133

7.0) Compiling:

   134

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

   135

Windows:

   136

  You need Microsoft Visual Studio .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

   140

  to work you need their development files. For best results, download the

   141

  openttd-useful.zip file from SourceForge under the Files tab. Put the header

   142

  files into your compiler's include/ directory and the library (.lib) files

   143

  into the lib/ directory.

   144

  For more help with VS see docs/Readme_Windows_MSVC.txt.

   145

   146

  You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW.

   147

  Please read the Makefile for more information.

   148

   149

Unix:

   150

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

   151

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

   152

   153

MacOS X:

   154

  Use "make" or Xcode (which will then call make for you)

   155

  This will give you a binary for your CPU type (PPC/Intel)

   156

  To make a universal binary type "make UNIVERSAL_BINARY:=1"

   157

   158

BeOS:

   159

  Use "make".

   160

   161

FreeBSD:

   162

  You need the port devel/sdl12 for a non-dedicated build.

   163

  graphics/png is optional for screenshots in the PNG format.

   164

  Use "gmake".

   165

   166

MorphOS:

   167

  Use "make". Note that you need the MorphOS SDK, latest libnix updates (else

   168

  C++ parts of OpenTTD will not build) and the powersdl.library SDK. Optionally

   169

  libz, libpng and freetype2 developer files.

   170

   171

OS/2:

   172

  Open Watcom C/C++ 1.3 or later is required to build the OS/2 version. See the

   173

  docs/Readme_OS2.txt file for more information.

   174

   175

   176

8.0) Translating:

   177

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

   178

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

   179

   180

The use of the online Translator service, located at

   181

http://translator2.openttd.org/, is highly encouraged. For a username/password

   182

combo you should contact the development team, either by mail, IRC or the

   183

forums. The system is straightforward to use, and if you have any problems,

   184

read the online help located there.

   185

   186

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

   187

information below might be of help.

   188

   189

8.1) Guidelines:

   190

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

   191

Here are some translation guidelines which you should follow closely.

   192

   193

    * Please contact the development team before beginning the translation

   194

      process! This avoids double work, as someone else may have already

   195

      started translating to the same language.

   196

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

   197

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

   198

    * Currently it is not possible to translate into character sets other than

   199

      Latin.

   200

   201

8.2) Translation:

   202

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

   203

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

   204

translate (You did, right? Of course you did.) you can pick up english.txt

   205

(found in the SVN repository under /lang) and translate.

   206

   207

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

   208

   209

##name English-Name-Of-Language

   210

##ownname Native-Name-Of-Language

   211

   212

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

   213

   214

    * String identifiers (the first word on each line)

   215

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

   216

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

   217

      the file

   218

   219

8.3) Previewing:

   220

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

   221

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

   222

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

   223

   224

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

   225

Example:

   226

   227

strgen lang/german.txt

   228

   229

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

   230

Any missing strings are replaced with the English strings. Note that it looks

   231

for english.txt in the lang subdirectory, which is where your language file

   232

should also be.

   233

   234

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

   235

   236

9.0) Troubleshooting

   237

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

   238

   239

To see all startup options available to you, start OpenTTD with the

   240

"./openttd -h" option. This might help you tweak some of the settings.

   241

   242

If the game is acting strange and you feel adventurous you can try the

   243

"-d [[<name>]=[<level>]" flag, where the higher levels will give you more

   244

debugging output. The "name" variable can help you to display only some type of

   245

debugging messages. This is mostly undocumented so best is to look in the

   246

source code file debug.c for the various debugging types. For more information

   247

look at http://wiki.openttd.org/index.php/Command_line.

   248

   249

The most frequent problem is missing data files. Don't forget to put all GRF

   250

files from TTD into your data/ folder including sample.cat!

   251

   252

Under Windows 98 and lower it is impossible to use a dedicated server; it will

   253

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

   254

for their stability.

   255

   256

With the added support for font-based text selecting a non-latin language will

   257

result in garbage (lots of '?') shown on screen. Please open your configuration

   258

file and add a desired font for small/medium/-and large_font. This can be a font

   259

name like "Tahoma" or a path to a font.

   260

   261

Any NewGRF file used in a game is stored inside the savegame and will refuse

   262

to load if you don't have that grf file available. A list of missing files

   263

will be output to the console at the moment, so use the '-d' flag (on windows)

   264

to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/)

   265

put them in the data/ folder and you're set to go.

   266

   267

X.X) Credits:

   268

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

   269

The OpenTTD team (in alphabetical order):

   270

  Jean-Francois Claeys (Belugas) - In training, not yet specialized

   271

  Bjarni Corfitzen (Bjarni)      - Mac OS X port, coder

   272

  Matthijs Kooijman (blathijs)   - Pathfinder-guru

   273

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

   274

  Tamás Faragó (Darkvater)       - Lead programmer

   275

  Loïc Guilloux (glx)            - In training, not yet specialized

   276

  Jaroslav Mazanec (KUDr)        - YAPG (Yet Another Pathfinder God) ;)

   277

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

   278

   279

  Peter Nelson (peter1138)       - Spiritual descendant from newgrf gods

   280

  Remko Bijker (Rubidium)        - THE desync hunter

   281

  Christoph Mallon (Tron)        - Programmer, code correctness police

   282

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

   283

   284

Retired Developers:

   285

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

   286

  Owen Rudge (orudge)            - Contributor, forum host, master server host, OS/2 port (0.1 - 0.4.8)

   287

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

   288

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

   289

   290

Thanks to:

   291

  Josef Drexler                  - For his great work on TTDPatch.

   292

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

   293

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

   294

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

   295

  Simon Sasburg (HackyKid)       - For the many bugfixes he has blessed us with (and future PBS)

   296

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

   297

  Mike Ragsdale                  - OpenTTD installer

   298

  Cian Duffy (MYOB)              - BeOS port / manual writing

   299

  Christian Rosentreter (tokai)  - MorphOS / AmigaOS port

   300

  Richard Kempton (RichK67)      - Additional airports, initial TGP implementation

   301

  Michael Blunck                 - For revolutionizing TTD with awesome graphics

   302

  George                         - Canal graphics

   303

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

   304

  Bug Reporters                  - Thanks for all bug reports

   305

  Chris Sawyer                   - For an amazing game!