Table of contents
- 1.0) About
- 2.0) Contacting
- 3.0) Supported platforms
- 4.0) Installing and running OpenTTD
- 5.0) OpenTTD features
- 6.0) Configuration file
- 7.0) Compiling
- 8.0) Translating
- 9.0) Troubleshooting
- 10.0) Licensing
- X.X) Credits
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.
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 Githubs issue tracker. You can find the tracker at https://github.com/OpenTTD/OpenTTD/issues. 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