Last updated: 2015-05-08 Release version: 1.5.1-RC1 ------------------------------------------------------------------------ Table of contents ----------------- 1.0) About 2.0) Contacting * 2.1) Reporting bugs * 2.2) Reporting desyncs 3.0) Supported platforms 4.0) Installing and running OpenTTD * 4.1) (Required) 3rd party files * 4.2) OpenTTD directories * 4.3) Portable installations (portable media) * 4.4) Files in tar (archives) 5.0) OpenTTD features * 5.1) Logging of potentially dangerous actions 6.0) Configuration file 7.0) Compiling * 7.1) Required/optional libraries * 7.2) Supported compilers * 7.3) Compilation of base sets 8.0) Translating * 8.1) Translation * 8.2) Previewing 9.0) Troubleshooting 10.0) Licensing X.X) Credits 1.0) About ---- ----- OpenTTD is a transport simulation game based upon the popular game Transport Tycoon Deluxe, written by Chris Sawyer. It attempts to mimic the original game as closely as possible while extending it with new features. OpenTTD is licensed under the GNU General Public License version 2.0, but includes some 3rd party software under different licenses. See the section "Licensing" below for details. 2.0) Contacting ---- ---------- The easiest way to contact the OpenTTD team is by submitting bug reports or posting comments in our forums. You can also chat with us on IRC (#openttd on irc.oftc.net). The OpenTTD homepage is http://www.openttd.org/. You can also find the OpenTTD forums at http://forum.openttd.org/ 2.1) Reporting bugs ---- -------------- First of all, check whether the bug is not already known. Do this by looking through the file called 'known-bugs.txt' which is distributed with OpenTTD like this readme. For tracking our bugs we are using a bug tracker called Flyspray. You can find the tracker at http://bugs.openttd.org/. Before actually reporting take a look through the already reported bugs there to see if the bug is already known. The 'known-bugs.txt' file might be a bit outdated at the moment you are reading it as only bugs known before the release are documented there. Also look through the recently closed bugs. When you are sure it is not already reported you should: * Make sure you are running a recent version, i.e. run the latest stable or nightly based on where you found the bug. * Make sure you are not running a non-official binary, like a patch pack. When you are playing with a patch pack you should report any bugs to the forum thread related to that patch pack. * Make it reproducible for the developers. In other words, create a savegame in which you can reproduce the issue once loaded. It is very useful to give us the crash.dmp, crash.sav, crash.log and crash screenshot which are created on crashes. * Check whether the bug is already reported on our bug tracker. This includes searching for recently closed bug reports as the bug might already be fixed. After you have done all that you can report the bug. Please include the following information in your bug report: * OpenTTD version (PLEASE test the latest SVN/nightly build) * Bug details, including instructions how to reproduce it * Platform (Windows, Linux, FreeBSD, ...) and compiler (including version) if you compiled OpenTTD yourself. * The processor architecture of your OS (32 bits Windows, 64 bits Windows, Linux on an ARM, Mac OS X on a PowerPC, ...) * Attach a saved game *and* a screenshot if possible * If this bug only occurred recently please note the last version without the bug and the first version including the bug. That way we can fix it quicker by looking at the changes made. * Attach crash.dmp, crash.log and crash.sav. These files are usually created next to your openttd.cfg. The crash handler will tell you the location. 2.2) Reporting desyncs ---- ----------------- As desyncs are hard to make reproducible OpenTTD has the ability to log all actions done by clients so we can replay the whole game in an effort to make desyncs better reproducible. You need to turn this ability on. When turned on an automatic savegame will be made once the map has been constructed in the 'save/autosave' directory, see OpenTTD directories to know where to find this directory. Furthermore the log file 'commands-out.log' will be created and all actions will be written to there. To enable the desync debugging you need to set the debug level for 'desync' to at least 1. You do this by starting OpenTTD with '-d desync=<level>' as parameter or by typing 'debug_level desync=<level>' in OpenTTD's internal console. The desync debug levels are: 0: nothing. 1: dumping of commands to 'commands-out.log'. 2: same as 1 plus checking vehicle caches and dumping that too. 3: same as 2 plus monthly saves in autosave. 4 and higher: same as 3 Restarting OpenTTD will overwrite 'commands-out.log'. OpenTTD will not remove the savegames (dmp_cmds_*.sav) made by the desync debugging system, so you have to occasionally remove them yourself! The naming format of the desync savegames is as follows: dmp_cmds_XXXXXXXX_YYYYYYYY.sav. The XXXXXXXX is the hexadecimal representation of the generation seed of the game and YYYYYYYY is the hexadecimal representation of the date of the game. This sorts the savegames by game and then by date making it easier to find the right savegames. When a desync has occurred with the desync debugging turned on you should file a bug report with the following files attached: - commands-out.log as it contains all the commands that were done - the last saved savegame (search for the last line beginning with 'save: dmp_cmds_' in commands-out.log). We use this savegame to check whether we can quickly reproduce the desync. Otherwise we will need... - the first saved savegame (search for the first line beginning with 'save' where the first part, up to the last underscore '_', is the same). We need this savegame to be able to reproduce the bug when the last savegame is not old enough. If you loaded a scenario or savegame you need to attach that. - optionally you can attach the savegames from around 50%, 75%, 85%, 90% and 95% of the game's progression. We can use these savegames to speed up the reproduction of the desync, but we should be able to reproduce these savegames based on the first savegame and commands-out.log. - in case you use any NewGRFs you should attach the ones you used unless we can easily find them ourselves via bananas or when they are in the #openttdcoop pack. Do NOT remove the dmp_cmds savegames of a desync you have reported until the desync has been fixed; if you, by accident, send us the wrong savegames we will not be able to reproduce the desync and thus will be unable to fix it. 3.0) Supported platforms ---- ------------------- OpenTTD has been ported to several platforms and operating systems. It should not be very difficult to port it to a new platform. The currently working platforms are: BeOS - SDL or Allegro DOS - Allegro FreeBSD - SDL Linux - SDL or Allegro MacOS X (universal) - Cocoa video and sound drivers MorphOS - SDL OpenBSD - SDL OS/2 - SDL Windows - Win32 GDI (faster) or SDL or Allegro 4.0) Installing and running OpenTTD ---- ------------------------------ Installing OpenTTD is fairly straightforward. Either you have downloaded an archive which you have to extract to a directory where you want OpenTTD to be installed, or you have downloaded an installer, which will automatically extract OpenTTD in the given directory. OpenTTD looks in multiple locations to find the required data files (described in section 4.2). Installing any 3rd party files into a 'shared' location has the advantage that you only need to do this step once, rather than copying the data files into all OpenTTD versions you have. Savegames, screenshots, etc are saved relative to the config file (openttd.cfg) currently being used. This means that if you use a config file in one of the shared directories, savegames will reside in the save/ directory next to the openttd.cfg file there. If you want savegames and screenshots in the directory where the OpenTTD binary resides, simply have your config file in that location. But if you remove this config file, savegames will still be in this directory (see notes in section 4.2 'OpenTTD directories') OpenTTD comes without AIs, so if you want to play with AIs you have to download them. The easiest way is via the 'Check Online Content' button in the main menu. You can select some AIs that you think are compatible with your playing style. Another way is manually downloading the AIs from the forum although then you need to make sure that you install all the required AI libraries too; they get automatically selected (and downloaded) if you get the AIs via the 'Check Online Content'. If you do not have an AI but have configured OpenTTD to start an AI a message will be shown that the 'dummy' AI has been started. 4.1) (Required) 3rd party files ---- -------------------------- Before you run OpenTTD, you need to put the game's data files into a baseset/ directory which can be located in various places addressed in the following section. For OpenTTD you need to acquire some third party data files. For this you have the choice of using the original Transport Tycoon Deluxe data files or a set of free data files. Do NOT copy files included with OpenTTD into 'shared' directories (explained in the following sections) as sooner or later you will run into graphical glitches when using other versions of the game. 4.1.1) Free graphics and sound files ------ ----------------------------- The free data files, split into OpenGFX for graphics, OpenSFX for sounds and Open...
smilingfish8