1

OpenTTD README

     2

Last updated:    2006-12-21

     3

Release version: 0.5.0-RC1

     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.freenode.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/daily 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/OpenTTDDevBlackBook

   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

  (see also docs/Readme_Mandrake_Linux.txt)

   153

   154

MacOS X:

   155

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

   156

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

   158

   159

BeOS:

   160

  Use "make".

   161

   162

FreeBSD:

   163

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

   164

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

   165

  Use "gmake".

   166

   167

MorphOS:

   168

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

   169

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

   170

  libz, libpng and freetype2 developer files.

   171

   172

OS/2:

   173

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

   174

  docs/Readme_OS2.txt file for more information.

   175

   176

   177

8.0) Translating:

   178

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

   179

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

   180

   181

The use of the online Translator service, located at

   182

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

   183

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

   184

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

   185

read the online help located there.

   186

   187

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

   188

information below might be of help.

   189

   190

8.1) Guidelines:

   191

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

   192

Here are some translation guidelines which you should follow closely.

   193

   194

    * Please contact the development team before beginning the translation

   195

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

   196

      started translating to the same language.

   197

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

   198

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

   199

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

   200

      Latin.

   201

   202

8.2) Translation:

   203

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

   204

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

   205

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

   206

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

   207

   208

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

   209

   210

##name English-Name-Of-Language

   211

##ownname Native-Name-Of-Language

   212

   213

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

   214

   215

    * String identifiers (the first word on each line)

   216

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

   217

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

   218

      the file

   219

   220

8.3) Previewing:

   221

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

   222

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

   223

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

   224

   225

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

   226

Example:

   227

   228

strgen lang/german.txt

   229

   230

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

   231

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

   232

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

   233

should also be.

   234

   235

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

   236

   237

9.0) Troubleshooting

   238

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

   239

   240

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

   241

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

   242

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

   250

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

   251

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

   252

   253

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

   254

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

   255

for their stability.

   256

   257

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

   258

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

   259

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

   260

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

   261

   262

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

   263

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

   264

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

   265

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

   266

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

   267

   268

X.X) Credits:

   269

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

   270

The OpenTTD team (in alphabetical order):

   271

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

   272

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

   273

  Matthijs Kooijman (blathijs)   - Pathfinder-guru

   274

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

   275

  Tamás Faragó (Darkvater)       - Lead programmer

   276

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

   277

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

   278

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

   279

   280

  Peter Nelson (peter1138)       - Spiritual descendant from newgrf gods

   281

  Remko Bijker (Rubidium)        - Belugas code scrutinizer",

   282

  Christoph Mallon (Tron)        - Programmer, code correctness police

   283

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

   284

   285

Retired Developers:

   286

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

   287

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

   288

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

   289

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

   290

   291

Thanks to:

   292

  Josef Drexler - For his great work on TTDPatch.

   293

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

   294

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

   295

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

   296

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

   297

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

   298

  Mike Ragsdale - OpenTTD installer

   299

  Cian Duffy (MYOB) - BeOS port / manual writing

   300

  Christian Rosentreter (tokai) - MorphOS / AmigaOS port

   301

  Richard Kempton (richK) - additional airports, initial TGP implementation

   302

  Michael Blunck - For revolutionizing TTD with awesome graphics

   303

  George - Canal graphics

   304

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

   305

  Bug Reporters - Thanks for all bug reports

   306

  Chris Sawyer - For an amazing game!