README.md

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