1

OpenTTD README

     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) Installing and 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://forum.openttd.org/

    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 *and* 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

  OpenBSD              - SDL

    79

  OS/2                 - SDL

    80

  Windows              - Win32 GDI (faster) or SDL

    81

    82

    83

4.0) Installing and running OpenTTD:

    84

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

    85

    86

Installing OpenTTD is fairly straightforward. Either you have downloaded an

    87

archive which you have to extract to a directory where you want OpenTTD to

    88

be installed, or you have downloaded an installer, which will automatically

    89

extract OpenTTD in the given directory.

    90

    91

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

    92

subdirectory. You need the following files from the original version

    93

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

    94

installer optionally can copy these files from your Transport Tycoon Deluxe

    95

CD-ROM.

    96

    97

List of the required files:

    98

sample.cat

    99

trg1r.grf

   100

trgcr.grf

   101

trghr.grf

   102

trgir.grf

   103

trgtr.grf

   104

   105

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

   106

TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF.

   107

   108

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

   109

OpenTTD folder, not your data folder.

   110

   111

   112

5.0) OpenTTD features:

   113

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

   114

   115

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

   116

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

   117

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

   118

controlled through the Configure Patches dialog. We also implement some

   119

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

   120

   121

Several important non-standard controls:

   122

   123

* Use Ctrl to place semaphore signals

   124

* Ingame console. More information at

   125

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

   126

   127

   128

6.0) Configuration File:

   129

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

   130

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

   131

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

   132

ingame by using the 'Configure Patches' window.

   133

   134

   135

7.0) Compiling:

   136

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

   137

Windows:

   138

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

   139

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

   140

  you need to add WITH_SDL to the project settings.

   141

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

   142

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

   143

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

   144

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

   145

  into the lib/ directory.

   146

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

   147

   148

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

   149

  Please read the Makefile for more information.

   150

   151

Solaris 10:

   152

  You need g++ (version 3 or higher), together with SDL. Installation of

   153

  libpng and zlib is recommended. For the first build it is required

   154

  to execute "bash configure" first. Note that ./configure does not work

   155

  yet. It is likely that you don't have a strip binary, so use the

   156

  --disable-strip option in that case. Fontconfig (>2.3.0) and freetype

   157

  are optional. "make run" will then run the program.

   158

   159

Unix:

   160

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

   161

  However, for the first build one has to do a "./configure" first.

   162

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

   163

   164

MacOS X:

   165

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

   166

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

   167

  However, for the first build one has to do a "./configure" first.

   168

  To make a universal binary type "./configure --enabled-universal"

   169

  instead of "./configure".

   170

   171

BeOS:

   172

  Use "make", but do a "./configure" before the first build.

   173

   174

FreeBSD:

   175

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

   176

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

   177

  Use "gmake", but do a "./configure" before the first build.

   178

   179

OpenBSD:

   180

  Use "gmake", but do a "./configure" before the first build.

   181

  Note that you need the port devel/sdl to compile OpenTTD.

   182

   183

MorphOS:

   184

  Use "make". However, for the first build one has to do a "./configure" first.

   185

  Note that you need the MorphOS SDK, latest libnix updates (else C++ parts of

   186

  OpenTTD will not build) and the powersdl.library SDK. Optionally libz,

   187

  libpng and freetype2 developer files.

   188

   189

OS/2:

   190

  A comprehensive GNU build environment is required to build the OS/2 version.

   191

  See the docs/Readme_OS2.txt file for more information.

   192

   193

   194

8.0) Translating:

   195

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

   196

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

   197

   198

The use of the online Translator service, located at

   199

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

   200

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

   201

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

   202

read the online help located there.

   203

   204

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

   205

information below might be of help.

   206

   207

8.1) Guidelines:

   208

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

   209

Here are some translation guidelines which you should follow closely.

   210

   211

    * Please contact the development team before beginning the translation

   212

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

   213

      started translating to the same language.

   214

   215

8.2) Translation:

   216

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

   217

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

   218

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

   219

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

   220

   221

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

   222

   223

##name English-Name-Of-Language

   224

##ownname Native-Name-Of-Language

   225

   226

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

   227

   228

    * String identifiers (the first word on each line)

   229

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

   230

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

   231

      the file

   232

   233

8.3) Previewing:

   234

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

   235

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

   236

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

   237

   238

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

   239

Example:

   240

   241

strgen lang/german.txt

   242

   243

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

   244

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

   245

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

   246

should also be.

   247

   248

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

   249

   250

9.0) Troubleshooting

   251

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

   252

   253

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

   254

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

   255

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

   263

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

   264

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

   265

   266

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

   267

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

   268

for their stability.

   269

   270

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

   271

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

   272

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

   273

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

   274

   275

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

   276

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

   277

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

   278

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

   279

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

   280

   281

X.X) Credits:

   282

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

   283

The OpenTTD team (in alphabetical order):

   284

  Jean-Francois Claeys (Belugas) - GUI, newindustries and more

   285

  Bjarni Corfitzen (Bjarni)      - MacOSX port, coder and vehicles

   286

  Matthijs Kooijman (blathijs)   - Pathfinder-guru, pool rework

   287

  Loïc Guilloux (glx)            - General coding

   288

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

   289

  Jonathan Coome (Maedhros)      - High priest of the newGRF Temple

   290

  Attila Bán (MiHaMiX)           - WebTranslator, Nightlies, Wiki and bugtracker host

   291

  Owen Rudge (orudge)            - Forum host, OS/2 port

   292

  Peter Nelson (peter1138)       - Spiritual descendant from newGRF gods

   293

  Remko Bijker (Rubidium)        - Lead coder and way more

   294

  Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker

   295

  Zdenek Sojka (SmatZ)           - Bug finder and fixer

   296

   297

Inactive Developers:

   298

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

   299

  Tamás Faragó (Darkvater)       - Ex-Lead coder

   300

  Christoph Mallon (Tron)        - Programmer, code correctness police

   301

   302

Retired Developers:

   303

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

   304

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

   305

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

   306

  Patric Stout (TrueLight)       - Programmer, webhoster (0.3 - pre0.6)

   307

   308

Thanks to:

   309

  Josef Drexler                  - For his great work on TTDPatch.

   310

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

   311

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

   312

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

   313

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

   314

  Mike Ragsdale                  - OpenTTD installer

   315

  Cian Duffy (MYOB)              - BeOS port / manual writing

   316

  Christian Rosentreter (tokai)  - MorphOS / AmigaOS port

   317

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

   318

  Michael Blunck                 - For revolutionizing TTD with awesome graphics

   319

  George                         - Canal graphics

   320

  David Dallaston (Pikka)        - Tram tracks

   321

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

   322

  Bug Reporters                  - Thanks for all bug reports

   323

  Chris Sawyer                   - For an amazing game!