# OpenTTD

## Table of contents

- 1.0) [About](#10-about)

    - 1.1) [Downloading OpenTTD](#11-downloading-openttd)

    - 1.2) [OpenTTD gameplay manual](#12-openttd-gameplay-manual)

    - 1.3) [Supported platforms](#13-supported-platforms)

    - 1.4) [Installing and running OpenTTD](#14-installing-and-running-openttd)

    - 1.5) [Add-on content / mods](#15-add-on-content--mods)

    - 1.6) [OpenTTD directories](#16-openttd-directories)

    - 1.7) [Compiling OpenTTD](#17-compiling-openttd)

- 2.0) [Contact and community](#20-contact-and-community)

    - 2.1) [Contributing to OpenTTD](#21-contributing-to-openttd)

    - 2.2) [Reporting bugs](#22-reporting-bugs)

    - 2.3) [Translating](#23-translating)

- 3.0) [Licensing](#30-licensing)

- 4.0) [Credits](#40-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"](#30-licensing) below for details.

## 1.1) Downloading OpenTTD

OpenTTD can be downloaded from the [official OpenTTD website](https://www.openttd.org/).

Both 'stable' and 'nightly' versions are available for download:

- most people should choose the 'stable' version, as this has been more extensively tested

- the 'nightly' version includes the latest changes and features, but may sometimes be less reliable

OpenTTD is also available for free on [Steam](https://store.steampowered.com/app/1536610/OpenTTD/), [GOG.com](https://www.gog.com/game/openttd), and the [Microsoft Store](https://www.microsoft.com/p/openttd-official/9ncjg5rvrr1c). On some platforms OpenTTD will be available via your OS package manager or a similar service.

## 1.2) OpenTTD gameplay manual

OpenTTD has a [community-maintained wiki](https://wiki.openttd.org/), including a gameplay manual and tips.

## 1.3) Supported platforms

OpenTTD has been ported to several platforms and operating systems.

The currently supported platforms are:

- Linux (SDL (OpenGL and non-OpenGL))

- macOS (universal) (Cocoa)

- Windows (Win32 GDI / OpenGL)

Other platforms may also work (in particular various BSD systems), but we don't actively test or maintain these.

### 1.3.1) Legacy support

Platforms, languages and compilers change.

We'll keep support going on old platforms as long as someone is interested in supporting them, except where it means the project can't move forward to keep up with language and compiler features.

We guarantee that every revision of OpenTTD will be able to load savegames from every older revision (excepting where the savegame is corrupt).

Please report a bug if you find a save that doesn't load.

## 1.4) Installing and running OpenTTD

OpenTTD is usually straightforward to install, but for more help the wiki [includes an installation guide](https://wiki.openttd.org/en/Manual/Installation).

OpenTTD needs some additional graphics and sound files to run.

For some platforms these will be downloaded during the installation process if required.

For some platforms, you will need to refer to [the installation guide](https://wiki.openttd.org/en/Manual/Installation).

### 1.4.1) Free graphics and sound files

The free data files, split into OpenGFX for graphics, OpenSFX for sounds and

OpenMSX for music can be found at:

Please follow the readme of these packages about the installation procedure.

The Windows installer can optionally download and install these packages.

### 1.4.2) Original Transport Tycoon Deluxe graphics and sound files

If you want to play with the original Transport Tycoon Deluxe data files you have to copy the data files from the CD-ROM into the baseset/ directory.

It does not matter whether you copy them from the DOS or Windows version of Transport Tycoon Deluxe.

The Windows install can optionally copy these files.

You need to copy the following files:

- sample.cat

- trg1r.grf or TRG1.GRF

- trgcr.grf or TRGC.GRF

- trghr.grf or TRGH.GRF

- trgir.grf or TRGI.GRF

- trgtr.grf or TRGT.GRF

### 1.4.3) Original Transport Tycoon Deluxe music

If you want the Transport Tycoon Deluxe music, copy the appropriate files from the original game into the baseset folder.

- TTD for Windows: All files in the gm/ folder (gm_tt00.gm up to gm_tt21.gm)

- TTD for DOS: The GM.CAT file

- Transport Tycoon Original: The GM.CAT file, but rename it to GM-TTO.CAT

## 1.5) Add-on content / mods

OpenTTD features multiple types of add-on content, which modify gameplay in different ways.

Most types of add-on content can be downloaded within OpenTTD via the 'Check Online Content' button in the main menu.

Add-on content can also be installed manually, but that's more complicated; the [OpenTTD wiki](https://wiki.openttd.org/) may offer help with that, or the [OpenTTD directory structure guide](./docs/directory_structure.md).

### 1.5.1) AI opponents

OpenTTD comes without AI opponents, 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.

AI help and discussions may also be found in the [AI section of the forum](https://www.tt-forums.net/viewforum.php?f=65).

### 1.5.2) Scenarios and height maps

Scenarios and heightmaps can be added via the 'Check Online Content' button in the main menu.

### 1.5.3) NewGRFs

A wide range of add-content is available as NewGRFs, including vehicles, industries, stations, landscape objects, town names and more.

NewGRFs can be added via the 'Check Online Content' button in the main menu.

See also the wiki [guide to NewGRFs](https://wiki.openttd.org/en/Manual/NewGRF) and [the forum graphics development section](https://www.tt-forums.net/viewforum.php?f=66).

### 1.5.4) Game scripts

Game scripts can provide additional challenges or changes to the standard OpenTTD gameplay, for example setting transport goals, or changing town growth behaviour.

Game scripts can be added via the 'Check Online Content' button in the main menu.

See also the wiki [guide to game scripts](https://wiki.openttd.org/en/Manual/Game%20script) and [the forum graphics game script section](https://www.tt-forums.net/viewforum.php?f=65).

### 1.6) OpenTTD directories

OpenTTD uses its own directory structure to store game data, add-on content etc.

For more information, see the [directory structure guide](./docs/directory_structure.md).

### 1.7) Compiling OpenTTD

If you want to compile OpenTTD from source, instructions can be found in [COMPILING.md](./COMPILING.md).

## 2.0) Contact and Community

'Official' channels

- [OpenTTD website](https://www.openttd.org)

- IRC chat using #openttd on irc.oftc.net [more info about our irc channel](https://wiki.openttd.org/en/Development/IRC%20channel)

- [forum.openttd.org](https://forum.openttd.org/) - the primary community forum site for discussing OpenTTD and related games

- [OpenTTD wiki](https://wiki.openttd.org/) community-maintained wiki, including topics like gameplay guide, detailed explanation of some game mechanics, how to use add-on content (mods) and much more

'Unofficial' channels

- the OpenTTD wiki has a [page listing OpenTTD communities](https://wiki.openttd.org/en/Community/Community) including some in languages other than English

### 2.1) Contributing to OpenTTD

We welcome contributors to OpenTTD.  More information for contributors can be found in [CONTRIBUTING.md](./CONTRIBUTING.md)

### 2.2) Reporting bugs

Good bug reports are very helpful.  We have a [guide to reporting bugs](./CONTRIBUTING.md#bug-reports) to help with this.

Desyncs in multiplayer are complex to debug and report (some software development skils are required).

Instructions can be found in [debugging and reporting desyncs](./docs/debugging_desyncs.md).

### 2.3) Translating

OpenTTD is translated into many languages.  Translations are added and updated via the [online translation tool](https://translator.openttd.org).

## 3.0) Licensing

OpenTTD is licensed under the GNU General Public License version 2.0.

For the complete license text, see the file '[COPYING.md](./COPYING.md)'.

This license applies to all files in this distribution, except as noted below.

The squirrel implementation in `src/3rdparty/squirrel` is licensed under the Zlib license.

See `src/3rdparty/squirrel/COPYRIGHT` for the complete license text.

The md5 implementation in `src/3rdparty/md5` is licensed under the Zlib license.

See the comments in the source files in `src/3rdparty/md5` for the complete license text.

The implementations of Posix `getaddrinfo` and `getnameinfo` for OS/2 in `src/3rdparty/os2` are distributed partly under the GNU Lesser General Public License 2.1, and partly under the (3-clause) BSD license.

The exact licensing terms can be found in `src/3rdparty/os2/getaddrinfo.c` resp. `src/3rdparty/os2/getnameinfo.c`.

The fmt implementation in `src/3rdparty/fmt` is licensed under the MIT license.

See `src/3rdparty/fmt/LICENSE.rst` for the complete license text.

## 4.0 Credits

See [CREDITS.md](./CREDITS.md)

12.1 (2021-11-08)

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

Feature: Button to toggle showing advanced signal types (#9617)

Change: Don't show screenshot GUI in screenshots (#9674)

Change: Suppress panning in intro game, while user is interacting with the GUI (#9645)

Change: Draw rotor in cursor when dragging helicopters in depots (#9612)

Fix: Invalid memory access when loading a currency NewGRF (#9675)

Fix #9579: Object and HQ construction is Construction cost, not Property Maintenance (#9673)

Fix #9669: Ships exiting a blocked depot/lock could exit in the wrong direction (#9672)

Fix: Every 16th client never reconnects after server restart (#9666)

Fix #9643: Screenshots were always written as BMP files (#9644)

Fix #9630: Intro game could zoom in/out more than allowed by settings (#9633)

Fix #9626: Incorrect loading of script saved data (#9629)

Fix: Emergency crash save had the wrong NewGRF list saved in it (#9627)

Fix #9595: Always use plural forms of cargo for subsidy strings (#9619)

Fix #9614: Refresh rate dropdown was still active when vsync was enabled (#9618)

Fix: Don't use 'server address' string in server list when displaying an invite code (#9615)

12.0 (2021-10-17)

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

Add: [Network] Keep the refresh button in lowered state while refreshing (#9600)

Add: Console command to list search directories for various things (#9583)

Fix: Try all possible reverse directions when a ship reaches a dead end (#9610)

Fix: Incorrect Romanian own name (#9598)

Fix #9591: Update station docking tiles upon placing a water object on a docking tile (#9594)

Fix #9548: [Squirrel] Crash during engine cleanup after reaching memory limit on realloc (#9592)

Fix #9588: [Squirrel] Reaching memory limit during script registration could prevent further script detections (#9589)

Fix: Make ships more likely to find their destination at the cost of slightly worse paths (#9576)

Change: Reverse ship when leaving docks if a better path exists (#9610)

Change: Allow all tiles around docks to be docking tiles (#9578)

12.0-RC1 (2021-09-25)

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

Feature: Display icon/text whether vehicle is lost in vehicle (list) window (#9543)

Feature: [MacOS] Add selected toolbar buttons to MacBook Pro Touch Bar (#9511)

Feature: Button to open order window from vehicle shared orders window (#9325)

Feature: Ctrl-Clicking shared order vehicle list opens order window (#9325)

Feature: Multiple rotating views on title screen (#8980)

Feature: Hide block signals in GUI by default (#8688)

Add: [Script] Allow GameScripts to build neutral objects (#9568)

Add: [Network] Allow sending chat messages via admin port (#9563)

Add: [AI/GS] Missing water related functions and objects (#8390)

Fix: Industry funding window did not update when changing funding method (#9572)

Fix #9562: [NewGRF] Handle case of invalid Action2 with zero results (#9564)

Fix: Incorrect error messages when placing water in scenario editor (#9560)

Fix #9484: Update locale currencies settings config map (#9559)

Fix: Prevent train reversing when entirely inside a train depot (#9557)

Fix: [Network] Add back 'Spectate' option to company toolbar menu (#9556)

Fix #9463: [Win32] Work around XAudio2 crashes (#9549)

Fix #8603: Don't give focus to text filter when opening Object GUI (#9547)

Fix #9241: Grove and forest tree brushes did not also create rainforest terrain (#9542)

Fix: [Network] Several crashes in our network code (#9534, #9456)

Fix #9527: Crash when trying to place multi-tile objects at map edge (#9529)

Fix: [Network] SendCmdNames only sent one name per packet (#9528)

Fix #9407: Desync when founding a town nearby a station (#9526)

Fix #9521: Don't load at just removed docks that were part of a multi-dock station (#9524)

Fix: Ships always tried to avoid docking tiles when pathfinding (even if nothing was on them) (#9522)

Fix: [Network] Convert server_advertise to server_game_type in config file (#9515)

Fix #9490: [Network] A full server couldn't be queried (#9508)

Fix: [Network] Don't show GameScript " (v0)" for old servers (#9507)

Fix: [Network] Show query errors in the server listing instead of error popup (#9506)

Fix: [Network] Crash when last-joined server was no longer available (#9503)

Fix #9501: [Network] Crash when more than one game-info query was pending (#9502)

Fix: Wrong error message when building canals over ship depots / locks (#9410)

Fix: Reduce cost of building canals over objects on sea (#9410)

Change: [Linkgraph] Delete links only served by vehicles stopped in depot (#9499)

12.0-beta2 (2021-08-19)

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

Feature: [Linkgraph] Prioritize faster routes for passengers, mail and express cargo (#9457)

Fix: Wrong town window refreshed when building an airport with noise levels enabled (#9497)

Fix: Improve wording of network-related messages (#9494, #9495, #9500)

Fix: [Network] Report reuse of invite-code (#9487)

Fix: [Network] Connecting with the same client name thrice hangs the server (#9485)

12.0-beta1 (2021-08-15)

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

Feature: [Network] Remove lobby window; pressing "Join Game" now immediately joins a server (#9467)

Feature: [Network] Synchronize server name to clients and display in Online Players window (#9472)

Feature: [Network] Mention you are a spectator in the status bar (#9471)

Feature: [Network] No longer require port-forwarding to host a server (#9443, #9447)

Feature: [Network] Allow setting your server visibility to "invite-only" (#9434)

Feature: [Network] Join servers based on their invite code (#9432)

Feature: Raise the maximum NewGRF limit to 255 (#9428)

Feature: Persistent rotation of numbered auto/netsave after restart (#9395, #9397)

Feature: [NewGRF] Maximum curve speed modifier for rail vehicles (#9346)

Feature: Move sensitive information to secrets.cfg and private information to private.cfg (#9298)

Feature: Signed Windows builds (#9294)

Feature: [NewGRF] Define refittability of default vehicles using cargo classes (#9148)

Feature: Configurable subsidy duration, up to 5000 years (#9081)

Feature: [Network] Rework in-game Online Players window (#9067)

Feature: [Network] Show previous chat history when the chat message box is open (#9025)

Feature: Button to reset game settings to their default values (#8958)

Feature: Press Ctrl to build diagonal rivers in Scenario Editor (#8880)

Feature: Set wagon replacement per group when using autoreplace (#7441)

Add: [Network] Open Online Players window on starting/joining a server (#9479)

Add: [Script] Basic information about loaded NewGRFs for scripts (#9464)

Add: [AI] Get the number of vehicles in a given group (#9462)

Add: [Network] Inform network clients what game-script a server is running (#9441)

Add: Hindi translation (#9086)

Add: [Network] Ensure players fill in a name instead of defaulting to "Player" (#9080)

Change: Allow pause/unpause console command in single player (#9342)

Change: Make savegame format self-descriptive and consistent across all objects (#9322, #9335, #9338, #9339)

Change: By default, make "unload all" leave stations empty (#9301)

Change: Reworked the debug levels and messages for network logs (#9230, #9251)

Change: [Emscripten] Set default scrolling mode to non-pointer-locking (#9191)

Change: Use neutral pronouns for various strings (#9189, #9203, #9228)

Change: Make the town directory horizontally resizable (#9157)

Change: Allow non-ASCII currency separators (#9121)

Change: [NewGRF] Display a pop-up window for Errors with severity ERROR (#9119)

Change: Treat languages as finished, if translations are 75% completed (#9019, #9086)

Change: Disable NewGRF window apply button if no change was made (#8934)

Fix: [Script] Crash when iterating lists of which the key is larger than 32bit (#9465)

Fix: [Network] Desync due to use of unstable sort when distributing cargo production (#9460)

Fix #9440: Negative cargo payments not being handled correctly (#9455)

Fix: [Network] Crash when joining a server again after a TCP disconnect (#9453)

Fix: Don't enable rename button for network clients in build vehicle window (#9452)

Fix: Money could underflow and wrap around (#9451)

Fix: Parse the console settings the same way as config settings (#9438)

Fix: Ensure no more than the allowed number of NewGRFs are loaded from the configuration (#9430)

Fix: [NewGRF] Overflow when determining cargo mask for string code 9A 1E (#9423)

Fix: Integers for scripts are 64bit, but saved as 32bit (#9415)

Fix #9392: [Script] Return a valid value with GetBuildWithRefitCapacity even when AIs are maxed out in vehicles (#9393)

Fix #8169: Crash when autoreplacing vehicle with no orders (#9387)

Fix: Wrong cargo line position in IndustryCargo window (#9383)

Fix: Race-condition during startup of NewGRF scan (#9382)

Fix: Don't propagate Shift/Ctrl state till next game-tick (#9381)

Fix: Prevent palette updates during copying to the video driver (#9379)

Fix: [Network] Determining GetNetworkRevisionString could overflow and underflow its buffer (#9372)

Fix #9358: Don't skip empty files in tar archives (#9367)

Fix: For old savegames, station bus/truck station cache was not updated (#9366)

Fix #9353: [Script] Garbage collecting on priority queues could crash the game (#9356)

Fix: Respect the autosave_on_exit setting for Null video driver (#9343)

Fix: Compatible NewGRFs in crash-log reported wrong MD5 hash (#9340)

Fix: [Script] Ensure the saved script strings are properly validated and terminated (#9336)

Fix #9316: Town bridge length limit check incorrect above 250k inhabitants (#9318)

Fix: Limit heightmap sizes to 8192x8192 (#9307)

Fix #9281: Money generating exploit when buying out a company (#9300)

Fix: Part of a tile might not be redrawn when terraforming (#9296)

Fix: [OpenGL] Increase timeout when waiting for the GPU to be done with the drawing buffer (#9282)

Fix: Vehicles sent in the wrong direction if there is no path to the destination (#9280)

Fix #9264: Do not attach temporary wagons to free wagon chains when autoreplacing (#9278)

Fix #9267: [Script] Crash during garbage collection (#9275)

Fix: Encountering two-way red signals could prune unrelated Pathfinder branches (#9271)

Fix #9255: [Network] Crash when hostname is not found (#9259)

Fix #9256: Invalid read after free when replacing train chains (#9258)

Fix: [Emscripten] Force secure WebSockets over HTTPS (#9248)

Fix #9242: Tree tick handler did not scale by map size (#9246)

Fix: [Network] Mark server as offline when no longer reachable (#9244)

Fix: [Network] Don't rebuild the host-list during iterating the list (#9240)

Fix: [Network] Don't mark the last-joined server as a manually added server (#9239)

Fix: [Network] Clients leaving because of broken connections was not broadcasted (#9238)

Fix: [Network] Check on CIDR for netmask check considered everything valid (#9235)

Fix: Creating screenshots on dedicated servers failed (#9232)

Fix: Leaking file descriptors for downloaded content (#9229)

Fix: Spelling of several town names (#9222)

Fix #9209: Game hangs when resizing highscore/news window if the screen is too small (#9210)

Fix: [Network] Optimize creating network connections for clients using IPv4 and IPv6 (#9199)

Fix #9186: Fix incorrect bounding box height causing station sprite glitch (#9187)

Fix: Truncating strings in settings could leave invalid UTF-8 characters (#9121)

Fix: Many issues related to window scaling (#9087, #9219)

Fix: Invalidate cached vehicle colourmaps when changing liveries setting (#9006)

Fix #8981: Don't attempt to re-reserve path if already entering/entered depot (#9000)

Fix: Missing 'Town names:' colon in map gen GUI (#8986)

Fix: Sorting and filtering industries that produce/accept many cargoes (#8468)

Remove: [Network] COMPANY_INFO packets (#9475)

Remove: [Network] A server can no longer set a limit to the amount of spectators allowed (#9466)

Remove: Arbitrary limit on number of statically loaded NewGRFs (#9431)

Remove: [Network] Language and map-name from server information (#9070)

1.11.2 (2021-05-03)

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

Change: [Win32] Limit hardware accelerated video driver to OpenGL 3.2 or higher (#9077)

Change: More improvements to the GUI at different scales (#9075, #9102, #9107, #9133, #9174, #9183)

Fix: Query windows could be partially drawn (#9184)

Fix #9113: Crash when removing an airport that exists in an aircraft's orders (#9182)

Fix #9117: [Fluidsynth] Hang when changing song (#9181)

Fix: String validation could leave invalid UTF-8 encoded strings (#9096)

Fix: [Network] Out-of-bounds memory access with modified servers sending too short password salts (#9176)

Fix: Crash when extra viewport with zero height has sign in view (#9175)

Fix #9147: Crash when taking screenshots (#9169)

Fix #6598: [Network] Prevent crashes when (re)joining network game by falling back to main menu first (#9163)

Fix #9152: Screenshot success popup window was treated as an error (#9159)

Fix: Fast-forward stuttering when vsync is enabled (#9140)

Fix: [Network, Win32] Network errors were handled badly (#9116)

Fix: [Network] Savegame transfer could stall in rare cases (#9106)

Fix #9097: [NewGRF] Cargo initial payment variable was being truncated (#9098)

The pack has become smaller over time, as most of the patches have slowly made their way into master or have been replaced with equivalent GRF files.

The patchpack currently includes the following patches:

 * Variable day length from "cargodist with sprinkles"

 * Colour code town names by company rating

 * Long char arrays for text entry boxes

 * Adjustable station naming convention

 * Manual adjustment of infrastructure base costs

 * Manual adjustment of running costs

 * Improved breakdowns patch

 * Manual adjustment of breakdown rates

 * Adjustable town growth factor separately from day length

 * Toggle whether or not inspectors will catch town bribes

 * Station dilapidation

 * Extended save data block

The patchpack is infrequently updated to newer versions of OpenTTD.

The patchpack is designed to be compatible with online play. Anyone else who is playing will need an identical version of the patchpack, plus any used NewGRFs.

It is not possible to play with people who have a vanilla/unmodified version of OpenTTD.