readme.txt
changeset 1734 1a9908670bc4
parent 1703 7e1cdd971cb2
child 1821 9e97d4970446
equal deleted inserted replaced
1733:7b74d376b184 1734:1a9908670bc4
    26 ---- ------
    26 ---- ------
    27 OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally
    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
    28 written by Chris Sawyer.  It attempts to mimic the original game as closely
    29 as possible while extending it with new features.
    29 as possible while extending it with new features.
    30 
    30 
       
    31 OpenTTD is licensed under the GNU General Public License version 2.0. For
       
    32 more information, see the file 'COPYING'.
    31 
    33 
    32 2.0) Contacting:
    34 2.0) Contacting:
    33 ---- ----------
    35 ---- ----------
    34 The easiest way to contact the OpenTTD team is by submitting bug reports or
    36 The easiest way to contact the OpenTTD team is by submitting bug reports or
    35 posting comments in our forums. You can also chat with us on IRC (#openttd
    37 posting comments in our forums. You can also chat with us on IRC (#openttd
    36 on irc.freenode.net).
    38 on irc.freenode.net).
    37 
    39 
    38 The OpenTTD homepage is http://www.openttd.org/.
    40 The OpenTTD homepage is http://www.openttd.org/.
    39 
    41 
    40 You can find a forum for OpenTTD at
    42 You can also find the OpenTTD forums at
    41 http://www.tt-forums.net/index.php?c=20
    43 http://www.tt-forums.net/index.php?c=20
    42 
    44 
    43 
    45 
    44 2.1) Reporting Bugs:
    46 2.1) Reporting Bugs:
    45 ---- ---------------
    47 ---- ---------------
    54 
    56 
    55 Please include the following information in your bug report:
    57 Please include the following information in your bug report:
    56         - OpenTTD version (PLEASE test the latest SVN/daily build)
    58         - OpenTTD version (PLEASE test the latest SVN/daily build)
    57         - Bug details, including instructions how to reproduce it
    59         - Bug details, including instructions how to reproduce it
    58         - Platform and compiler (Win32, Linux, FreeBSD, ...)
    60         - Platform and compiler (Win32, Linux, FreeBSD, ...)
    59         - Attach a save game or a screenshot if possible
    61         - Attach a saved game or a screenshot if possible
    60         - If this bug only occurred recently please note the last
    62         - If this bug only occurred recently please note the last
    61           version without the bug and the first version including
    63           version without the bug and the first version including
    62           the bug. That way we can fix it quicker by looking at the
    64           the bug. That way we can fix it quicker by looking at the
    63           changes made.
    65           changes made.
    64 
    66 
    70 are:
    72 are:
    71 
    73 
    72 	Windows - Win32 GDI (faster) or SDL
    74 	Windows - Win32 GDI (faster) or SDL
    73 	Linux - SDL
    75 	Linux - SDL
    74 	FreeBSD - SDL
    76 	FreeBSD - SDL
    75 	MacOSX - SDL
    77 	Mac OS X - SDL
    76 	BeOS - SDL
    78 	BeOS - SDL
    77 	MorphOS - SDL
    79 	MorphOS - SDL
       
    80 	OS/2 - SDL
    78 
    81 
    79 
    82 
    80 4.0) Running OpenTTD:
    83 4.0) Running OpenTTD:
    81 ---- ----------------
    84 ---- ----------------
    82 
    85 
   106 
   109 
   107 5.0) OpenTTD features:
   110 5.0) OpenTTD features:
   108 ---- -----------------
   111 ---- -----------------
   109 
   112 
   110 OpenTTD has a lot of features going beyond the original TTD emulation.
   113 OpenTTD has a lot of features going beyond the original TTD emulation.
   111 Currently there is unfortunately no comprehensive list of features. You could
   114 Unfortunately, there is currently no comprehensive list of features, but there is
   112 check the features list on the web, and some optional features can be
   115 a basic features list on the web, and some optional features can be
   113 controlled through the Configure patches dialog. We also implement some
   116 controlled through the Configure Patches dialog. We also implement some
   114 features known from TTDPatch (http://www.ttdpatch.net/).
   117 features known from TTDPatch (http://www.ttdpatch.net/).
   115 
   118 
   116 Several important non-standard controls:
   119 Several important non-standard controls:
   117 
   120 
   118 * Use Ctrl to place presignals
   121 * Use Ctrl to place presignals
   119 * Ctrl-d toggles double mode on win32
   122 * Ctrl-D toggles double mode in the Windows version
   120 * Ingame console. More information at http://wiki.openttd.org/index.php/OpenTTDDevBlackBook
   123 * Ingame console. More information at http://wiki.openttd.org/index.php/OpenTTDDevBlackBook
   121 
   124 
   122 
   125 
   123 6.0) Configuration File:
   126 6.0) Configuration File:
   124 ---- -------------------
   127 ---- -------------------
   125 The configuration file for OpenTTD (openttd.cfg) is in a simple windows-like
   128 The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like
   126 .INI format. It's mostly undocumented. Almost all settings can be changed ingame by
   129 .INI format. It's mostly undocumented. Almost all settings can be changed ingame by
   127 using the 'Configure patches' window.
   130 using the 'Configure Patches' window.
   128 
   131 
   129 
   132 
   130 7.0) Compiling:
   133 7.0) Compiling:
   131 ---- ----------
   134 ---- ----------
   132 Windows:
   135 Windows:
   133   You need Microsoft Visual Studio 6 or .NET. Open the project file
   136   You need Microsoft Visual Studio 6 or .NET. Open the project file
   134   and it should build automatically. In case you want to build with SDL support
   137   and it should build automatically. In case you want to build with SDL support
   135   you need to add WITH_SDL to the project settings.
   138   you need to add WITH_SDL to the project settings.
   136   PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these to
   139   PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these to
   137   work you need their development files. Best is to download the openttd-useful.zip
   140   work you need their development files. For best results, download the openttd-useful.zip
   138   file from SourceForge under the File tab. Put the header files into your compiler's
   141   file from SourceForge under the Files tab. Put the header files into your compiler's
   139   include/ directory and the library (.lib) files into the lib/ directory. For more help
   142   include/ directory and the library (.lib) files into the lib/ directory. For more help
   140   with VS6 see docs/Readme_Windows_MSVC6.0.txt.
   143   with VS6 see docs/Readme_Windows_MSVC6.0.txt.
   141 
   144 
   142   You can also build it using the Makefile with MSys/MingW or Cygwin/MingW.
   145   You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW.
   143   Please read the Makefile for more information.
   146   Please read the Makefile for more information.
   144 
   147 
   145 Unix:
   148 Unix:
   146   OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake".
   149   OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake".
   147   Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD.
   150   Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD.
   151   Use "make".
   154   Use "make".
   152 
   155 
   153 BeOS:
   156 BeOS:
   154   Use "make".
   157   Use "make".
   155 
   158 
   156 FreeBSD
   159 FreeBSD:
   157   Use "gmake".
   160   Use "gmake".
   158 
   161 
   159 MorphOS
   162 MorphOS:
   160   Use "make". Note that you need the MorphOS SDK and the
   163   Use "make". Note that you need the MorphOS SDK and the
   161   powersdl.library SDK.
   164   powersdl.library SDK.
   162 
   165 
       
   166 OS/2:
       
   167   Open Watcom C/C++ 1.3 or later is required to build the OS/2 version. See the
       
   168   docs/Readme_OS2.txt file for more information.
       
   169 
       
   170 
   163 8.0) Translating:
   171 8.0) Translating:
   164 ---- -------------------
   172 ---- -------------------
   165 See http://www.openttd.org/translating.php for up-to-date information.
   173 See http://www.openttd.org/translating.php for up-to-date information.
   166 
   174 
   167 The use of the online Translator service, located at http://translator.openttd.org is
   175 The use of the online Translator service, located at http://translator.openttd.org/, is
   168 highly encouraged. For a username password combo you should contact the development team,
   176 highly encouraged. For a username/password combo you should contact the development team,
   169 either by mail, irc or the forums. The system is straight-forward to use, if you have any
   177 either by mail, IRC or the forums. The system is straightforward to use, and if you have any
   170 troubles, read the online help located there.
   178 problems, read the online help located there.
   171 
   179 
   172 If for some reason the website is down for a longer period of time, the information below
   180 If for some reason the website is down for a longer period of time, the information below
   173 might be of help.
   181 might be of help.
   174 
   182 
   175 8.1) Guidelines:
   183 8.1) Guidelines:
   178 
   186 
   179     * Please contact the development team before begining the translation process!
   187     * Please contact the development team before begining the translation process!
   180       This avoids double work, as someone else may have already started translating to the same language.
   188       This avoids double work, as someone else may have already started translating to the same language.
   181     * Translators must use the charater set ISO 8859-15.
   189     * Translators must use the charater set ISO 8859-15.
   182       Otherwise, some characters will not display correctly in the game.
   190       Otherwise, some characters will not display correctly in the game.
   183     * Currently it is not possible to translate into other charactersets than Latin, also changing
   191     * Currently it is not possible to translate into character sets other than Latin. Also, changing
   184       the order of strings is unsupported. Eg. it is always '16tonnes of coal' and cannot be
   192       the order of strings is unsupported. For instance, it is always '16 tonnes of coal' and cannot be
   185       'coal existing of 16tonnes'
   193       'coal existing of 16 tonnes'
   186 
   194 
   187 8.2) Translation:
   195 8.2) Translation:
   188 ---- -------------------
   196 ---- -------------------
   189 So, now that you've notified the development team about your intention to translate
   197 So, now that you've notified the development team about your intention to translate
   190 (You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository
   198 (You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository
   210 Example:
   218 Example:
   211 
   219 
   212 strgen lang/german.txt
   220 strgen lang/german.txt
   213 
   221 
   214 This results in compiling german.txt and produces another file named german.lng.
   222 This results in compiling german.txt and produces another file named german.lng.
   215 Any missing strings are replaced with the english strings. Note that it looks for english.txt
   223 Any missing strings are replaced with the English strings. Note that it looks for english.txt
   216 in the lang subdirectory, which is where your language file should also be.
   224 in the lang subdirectory, which is where your language file should also be.
   217 
   225 
   218 That's all! You should now be able to select the language in the game options.
   226 That's all! You should now be able to select the language in the game options.
   219 
   227 
   220 9.0) Troubleshooting
   228 9.0) Troubleshooting
       
   229 ---- ---------------
       
   230 
   221 To see all startup options available to you, start OpenTTD with the "./openttd -h"
   231 To see all startup options available to you, start OpenTTD with the "./openttd -h"
   222 option. This might help you tweak some of the settings.
   232 option. This might help you tweak some of the settings.
   223 If the game is acting weird and you feel adventorous you can try the "-d [[<name>]=[<level>]"
   233 
   224 flag, where the higher levels will give you more debugging output. The name can help
   234 If the game is acting strange and you feel adventorous you can try the "-d [[<name>]=[<level>]"
   225 you to filter out only some type of debugging messages. This is mostly undocumented
   235 flag, where the higher levels will give you more debugging output. The "name" variable can help
   226 so best is to look in debug.c for the various debugging types. For more information
   236 you to display only some type of debugging messages. This is mostly undocumented
   227 look at http://wiki.openttd.org/index.php/Command_line
   237 so best is to look in the source code file debug.c for the various debugging types. For more
   228 
   238 information look at http://wiki.openttd.org/index.php/Command_line.
   229 The most frequent problem is missing data files. Don't forget to put all grf
   239 
   230 files from TTD into your data/ folder including sample.cat!
   240 The most frequent problem is missing data files. Don't forget to put all GRF files from TTD
       
   241 into your data/ folder including sample.cat!
       
   242 
   231 Another, less frequent problem is the game refusing to run when you don't have a
   243 Another, less frequent problem is the game refusing to run when you don't have a
   232 soundcard. To solve this, force OpenTTD to run without sound/music by running it with
   244 sound card. To solve this, force OpenTTD to run without sound/music by running it with
   233 the command line option: "./openttd -s null -m null". This will disable both sound
   245 the command line option: "./openttd -s null -m null". This will disable both sound
   234 and music.
   246 and music.
   235 Under Windows98 and lower it is impossible to use a dedicated server; it will fail to
   247 
       
   248 Under Windows 98 and lower it is impossible to use a dedicated server; it will fail to
   236 start. Perhaps this is for the better because those OS's are not known for their stability.
   249 start. Perhaps this is for the better because those OS's are not known for their stability.
   237 
   250 
   238 X.X) Credits:
   251 X.X) Credits:
   239 ---- --------
   252 ---- --------
   240 The OpenTTD team (in alphabetical order):
   253 The OpenTTD team (in alphabetical order):
   241   Bjarni Corfitzen (Bjarni)      - MacOSX port, coder
   254   Bjarni Corfitzen (Bjarni)      - Mac OS X port, coder
   242   Victor Fischer (Celestar)      - Programming everywhere you need him to
   255   Victor Fischer (Celestar)      - Programming everywhere you need him to
   243   Tamas Faragó (Darkvater)       - Lead programmer
   256   Tamas Faragó (Darkvater)       - Lead programmer
   244   Kerekes Miham (MiHaMiX)        - Maintainer of translator service, and host of nightlies
   257   Kerekes Miham (MiHaMiX)        - Maintainer of translator service, and host of nightlies
   245   Owen Rudge (orudge)            - Contributor, forum host, masterserver host
   258   Owen Rudge (orudge)            - Contributor, forum host, master server host, OS/2 port
   246   Christoph Mallon (Tron)        - Programmer, code correctness police
   259   Christoph Mallon (Tron)        - Programmer, code correctness police
   247   Patric Stout (TrueLight)       - Programmer, network guru, SVN-repository and website host
   260   Patric Stout (TrueLight)       - Programmer, network guru, SVN-repository and website host
   248 
   261 
   249 Retired Developers:
   262 Retired Developers:
   250   Dominik Scherer (dominik81)    - Lead programmer, GUI expert (0.3.0 - 0.3.6)
   263   Dominik Scherer (dominik81)    - Lead programmer, GUI expert (0.3.0 - 0.3.6)