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