1

OpenTTD README

     2

Last updated:    $LastChangedDate: 2004-07-25 21:22:11 +0200 (Sun, 25 Jul 2004) $

     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

    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 Windows version

    84

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

    85

    86

IMPORTANT! You need the files from the WINDOWS version of TTD.

    87

    88

List of the required files:

    89

sample.cat

    90

trg1r.grf

    91

trgcr.grf

    92

trghr.grf

    93

trgir.grf

    94

trgtr.grf

    95

    96

If you want music you need to copy the gm/ folder from Windows TTD into your OpenTTD folder, not your data folder.

    97

    98

You can change the data path (which contains savegames as well) in Makefile.config by setting DATA_DIR_PREFIX and USE_HOMEDIR.

    99

   100

   101

5.0) OpenTTD features:

   102

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

   103

   104

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

   105

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

   106

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

   107

controlled through the Configure patches dialog. We also implement some

   108

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

   109

   110

Several important non-standard controls:

   111

   112

* Use Ctrl to place presignals

   113

* Ctrl-d toggles double mode on win32

   114

   115

   116

6.0) Configuration File:

   117

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

   118

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

   119

.INI format. It's mostly undocumented.

   120

   121

   122

7.0) Compiling:

   123

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

   124

Windows:

   125

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

   126

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

   127

  you need to remove WITH_SDL from the project settings.

   128

  (see also docs/Readme_Windows_MSVC6.0.txt)

   129

   130

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

   131

  Please read the Makefile for more information.

   132

   133

Unix:

   134

  OpenTTD can be built either with "make" or with "jam". To build with

   135

  "make", just type "make", or "gmake" on non-gnu systems. To build with "jam",

   136

  first run "./configure" and then "jam". Note that you need SDL to compile

   137

  OpenTTD.

   138

  (see also docs/Readme_Mandrake_Linux.txt)

   139

   140

MacOS:

   141

  Use "make".

   142

   143

BeOS:

   144

  Use "jam".

   145

   146

FreeBSD

   147

  Use "gmake".

   148

   149

MorphOS

   150

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

   151

  powersdl.library SDK.

   152

   153

8.0) Translating:

   154

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

   164

   165

8.1) Guidelines:

   166

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

   167

Here are some translation guidelines which you should follow closely.

   168

   169

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

   170

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

   171

    * Translators must use the charater set "Windows latin-1", also known as ISO 8859-1.

   172

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

   173

   174

8.2) Translation:

   175

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

   176

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

   177

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

   178

under /lang) and translate.

   179

   180

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

   181

   182

##name English-Name-Of-Language

   183

##ownname Native-Name-Of-Language

   184

   185

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

   186

   187

    * String identifiers (the first word on each line)

   188

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

   189

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

   190

   191

8.3) Previewing:

   192

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

   193

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

   194

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

   195

   196

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

   197

Example:

   198

   199

strgen lang/german.txt

   200

   201

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

   202

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

   203

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

   204

   205

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

   206

   207

   208

X.X) Credits:

   209

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

   210

The OpenTTD team:

   213

  Dominik Scherer (dominik81)    - Coder

   214

  Tamas Farago (Darkvater)       - Coder

   218

  Bjarni Corfitzen (Bjarni)      - MacOS port

   220

  Cian Duffy (MYOB)              - BeOS port / manual writing

   221

  Christian Rosentreter (tokaiz) - MorphOS/AmigaOS port

   223

Thanks to:

   224

  Josef Drexler - For his great work on TTDPatch.

   225

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

   226

  Mike Ragsdale - OpenTTD installer

   229

  pasky - Many patches, newgrf support, etc.

   232

  truesatan - Some patches

   233

  Michael Polnick - Some patches

   234

  Michael Blunck - Nice graphics

   235

  George - Canal graphics

   237

  Bug Reporters - Thanks for all bug reports.