1# OpenTTD 2 3## Table of contents 4 5- 1.0) [About](#10-about) 6 - 1.1) [Downloading OpenTTD](#11-downloading-openttd) 7 - 1.2) [OpenTTD gameplay manual](#12-openttd-gameplay-manual) 8 - 1.3) [Supported platforms](#13-supported-platforms) 9 - 1.4) [Installing and running OpenTTD](#14-installing-and-running-openttd) 10 - 1.5) [Add-on content / mods](#15-add-on-content--mods) 11 - 1.6) [OpenTTD directories](#16-openttd-directories) 12 - 1.7) [Compiling OpenTTD](#17-compiling-openttd) 13- 2.0) [Contact and community](#20-contact-and-community) 14 - 2.1) [Contributing to OpenTTD](#21-contributing-to-openttd) 15 - 2.2) [Reporting bugs](#22-reporting-bugs) 16 - 2.3) [Translating](#23-translating) 17- 3.0) [Licensing](#30-licensing) 18- 4.0) [Credits](#40-credits) 19 20## 1.0) About 21 22OpenTTD is a transport simulation game based upon the popular game Transport Tycoon Deluxe, written by Chris Sawyer. 23It attempts to mimic the original game as closely as possible while extending it with new features. 24 25OpenTTD is licensed under the GNU General Public License version 2.0, but includes some 3rd party software under different licenses. 26See the section ["Licensing"](#30-licensing) below for details. 27 28## 1.1) Downloading OpenTTD 29 30OpenTTD can be downloaded from the [official OpenTTD website](https://www.openttd.org/). 31 32Both 'stable' and 'nightly' versions are available for download: 33 34- most people should choose the 'stable' version, as this has been more extensively tested 35- the 'nightly' version includes the latest changes and features, but may sometimes be less reliable 36 37OpenTTD 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. 38 39 40## 1.2) OpenTTD gameplay manual 41 42OpenTTD has a [community-maintained wiki](https://wiki.openttd.org/), including a gameplay manual and tips. 43 44 45## 1.3) Supported platforms 46 47OpenTTD has been ported to several platforms and operating systems. 48 49The currently supported platforms are: 50 51- Linux (SDL (OpenGL and non-OpenGL)) 52- macOS (universal) (Cocoa) 53- Windows (Win32 GDI / OpenGL) 54 55Other platforms may also work (in particular various BSD systems), but we don't actively test or maintain these. 56 57### 1.3.1) Legacy support 58Platforms, languages and compilers change. 59We'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. 60 61We guarantee that every revision of OpenTTD will be able to load savegames from every older revision (excepting where the savegame is corrupt). 62Please report a bug if you find a save that doesn't load. 63 64## 1.4) Installing and running OpenTTD 65 66OpenTTD is usually straightforward to install, but for more help the wiki [includes an installation guide](https://wiki.openttd.org/en/Manual/Installation). 67 68OpenTTD needs some additional graphics and sound files to run. 69 70For some platforms these will be downloaded during the installation process if required. 71 72For some platforms, you will need to refer to [the installation guide](https://wiki.openttd.org/en/Manual/Installation). 73 74 75### 1.4.1) Free graphics and sound files 76 77The free data files, split into OpenGFX for graphics, OpenSFX for sounds and 78OpenMSX for music can be found at: 79 80- https://www.openttd.org/downloads/opengfx-releases/ for OpenGFX 81- https://www.openttd.org/downloads/opensfx-releases/ for OpenSFX 82- https://www.openttd.org/downloads/openmsx-releases/ for OpenMSX 83 84Please follow the readme of these packages about the installation procedure. 85The Windows installer can optionally download and install these packages. 86 87 88### 1.4.2) Original Transport Tycoon Deluxe graphics and sound files 89 90If 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. 91It does not matter whether you copy them from the DOS or Windows version of Transport Tycoon Deluxe. 92The Windows install can optionally copy these files. 93 94You need to copy the following files: 95- sample.cat 96- trg1r.grf or TRG1.GRF 97- trgcr.grf or TRGC.GRF 98- trghr.grf or TRGH.GRF 99- trgir.grf or TRGI.GRF 100- trgtr.grf or TRGT.GRF 101 102 103### 1.4.3) Original Transport Tycoon Deluxe music 104 105If you want the Transport Tycoon Deluxe music, copy the appropriate files from the original game into the baseset folder. 106- TTD for Windows: All files in the gm/ folder (gm_tt00.gm up to gm_tt21.gm) 107- TTD for DOS: The GM.CAT file 108- Transport Tycoon Original: The GM.CAT file, but rename it to GM-TTO.CAT 109 110 111## 1.5) Add-on content / mods 112 113OpenTTD features multiple types of add-on content, which modify gameplay in different ways. 114 115Most types of add-on content can be downloaded within OpenTTD via the 'Check Online Content' button in the main menu. 116 117Add-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). 118 119### 1.5.1) AI opponents 120 121OpenTTD comes without AI opponents, so if you want to play with AIs you have to download them. 122 123The easiest way is via the 'Check Online Content' button in the main menu. 124 125You can select some AIs that you think are compatible with your playing style. 126 127AI help and discussions may also be found in the [AI section of the forum](https://www.tt-forums.net/viewforum.php?f=65). 128 129### 1.5.2) Scenarios and height maps 130 131Scenarios and heightmaps can be added via the 'Check Online Content' button in the main menu. 132 133### 1.5.3) NewGRFs 134 135A wide range of add-content is available as NewGRFs, including vehicles, industries, stations, landscape objects, town names and more. 136 137NewGRFs can be added via the 'Check Online Content' button in the main menu. 138 139See 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). 140 141### 1.5.4) Game scripts 142 143Game scripts can provide additional challenges or changes to the standard OpenTTD gameplay, for example setting transport goals, or changing town growth behaviour. 144 145Game scripts can be added via the 'Check Online Content' button in the main menu. 146 147See 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). 148 149### 1.6) OpenTTD directories 150 151OpenTTD uses its own directory structure to store game data, add-on content etc. 152 153For more information, see the [directory structure guide](./docs/directory_structure.md). 154 155### 1.7) Compiling OpenTTD 156 157If you want to compile OpenTTD from source, instructions can be found in [COMPILING.md](./COMPILING.md). 158 159 160## 2.0) Contact and Community 161 162'Official' channels 163 164- [OpenTTD website](https://www.openttd.org) 165- IRC chat using #openttd on irc.oftc.net [more info about our irc channel](https://wiki.openttd.org/en/Development/IRC%20channel) 166- [OpenTTD on Github](https://github.com/openTTD/) for code repositories and for reporting issues 167- [forum.openttd.org](https://forum.openttd.org/) - the primary community forum site for discussing OpenTTD and related games 168- [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 169 170'Unofficial' channels 171 172- the OpenTTD wiki has a [page listing OpenTTD communities](https://wiki.openttd.org/en/Community/Community) including some in languages other than English 173 174 175### 2.1) Contributing to OpenTTD 176 177We welcome contributors to OpenTTD. More information for contributors can be found in [CONTRIBUTING.md](./CONTRIBUTING.md) 178 179 180### 2.2) Reporting bugs 181 182Good bug reports are very helpful. We have a [guide to reporting bugs](./CONTRIBUTING.md#bug-reports) to help with this. 183 184Desyncs in multiplayer are complex to debug and report (some software development skils are required). 185Instructions can be found in [debugging and reporting desyncs](./docs/debugging_desyncs.md). 186 187 188### 2.3) Translating 189 190OpenTTD is translated into many languages. Translations are added and updated via the [online translation tool](https://translator.openttd.org). 191 192 193## 3.0) Licensing 194 195OpenTTD is licensed under the GNU General Public License version 2.0. 196For the complete license text, see the file '[COPYING.md](./COPYING.md)'. 197This license applies to all files in this distribution, except as noted below. 198 199The squirrel implementation in `src/3rdparty/squirrel` is licensed under the Zlib license. 200See `src/3rdparty/squirrel/COPYRIGHT` for the complete license text. 201 202The md5 implementation in `src/3rdparty/md5` is licensed under the Zlib license. 203See the comments in the source files in `src/3rdparty/md5` for the complete license text. 204 205The 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. 206The exact licensing terms can be found in `src/3rdparty/os2/getaddrinfo.c` resp. `src/3rdparty/os2/getnameinfo.c`. 207 208The fmt implementation in `src/3rdparty/fmt` is licensed under the MIT license. 209See `src/3rdparty/fmt/LICENSE.rst` for the complete license text. 210 211 212## 4.0 Credits 213 214See [CREDITS.md](./CREDITS.md) 215