OpenTTD README Last updated: 2009-08-01 Release version: 0.7.2 ------------------------------------------------------------------------ Table of Contents: ------------------ 1.0) About 2.0) Contacting * 2.1 Reporting Bugs 3.0) Supported Platforms 4.0) Installing and running OpenTTD * 4.1 (Required) 3rd party files * 4.2 OpenTTD directories * 4.3 Portable Installations (External Media) 5.0) OpenTTD features 6.0) Configuration File 7.0) Compiling 8.0) Translating * 8.1 Guidelines * 8.2 Translation * 8.3 Previewing 9.0) Troubleshooting X.X) Credits 1.0) About: ---- ------ OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally 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. For more information, see the file 'COPYING'. 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: ---- --------------- To report a bug, please create a Flyspray account and follow the bugs link from our homepage. Please make sure the bug is reproducible and still occurs in the latest daily build or the current SVN version. Also please look through the existing bug reports briefly to see whether the bug is not already known. The Flyspray project page URL is: http://bugs.openttd.org/ 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 and compiler (Win32, Linux, FreeBSD, ...) - 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 from the data directory if they exist. 2.2) Reporting Desyncs: ---- ------------------ As desyncs are hard to make reproducable 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 reproducable. 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 e.g. grfcrawler 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 shouldn't 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 (SDL works too, but not 100% and not as a universal binary) 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) 4.1) (Required) 3rd party files: ---- --------------------------- Before you run OpenTTD, you need to put the game's datafiles into a data/ directory which can be located in various places addressed in the following section. As OpenTTD makes use of the original TTD artwork you will need the files listed below, which you can find on a Transport Tycoon Deluxe CD-ROM. The Windows installer optionally can copy these files from that CD-ROM. List of the required files: - sample.cat - trg1r.grf - trgcr.grf - trghr.grf - trgir.grf - trgtr.grf Alternatively you can use the TTD GRF files from the DOS version: - TRG1.GRF - TRGC.GRF - TRGH.GRF - TRGI.GRF - TRGT.GRF If you want the TTD music, copy the gm/ folder from the Windows version of TTD to your OpenTTD folder (not your data folder - also explained in the following sections). 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. If you want AIs use the in-game content downloader to download some or download some from the internet and place them in the ai/ directory. 4.2) OpenTTD directories ---- ------------------------------- The TTD artwork files listed in the section 4.1 "(Required) 3rd party files" can be placed in a few different locations: 1. The current working directory (from where you started OpenTTD) 2. Your personal directory Windows: C:\Documents and Settings\<username>\My Documents\OpenTTD Mac OSX: ~/Documents/OpenTTD Linux: ~/.openttd 3. The shared directory Windows: C:\Documents and Settings\All Users\Documents\OpenTTD Mac OSX: /Library/Application Support/OpenTTD Linux: not available 4. The binary directory (where the OpenTTD executable is) Windows: C:\Program Files\OpenTTD Linux: /usr/games 5. The installation directory (Linux only) Linux: /usr/share/games/openttd 6. The application bundle (Mac OSX only) It includes the OTTD files (grf+lng) and it will work as long as they aren't touched Notes: - Linux in the previous list means .deb, but most paths should be similar for others. - The previous search order is also used for newgrfs and openttd.cfg. - If openttd.cfg is not found, then it will be created using the 2, 4, 1, 3, 5 order. - Savegames will be relative to the config file only if there is no save/ directory in paths with higher priority than the config file path, but autosaves and screenshots will always be relative to the config file. The prefered setup: Place 3rd party files in shared directory (or in personal directory if you don't have write access on shared directory) and have your openttd.cfg config file in personal directory (where the game will then also place savegames and screenshots). 4.3) Portab...
smilingfish8