diff options
| author | Patric Stout <truebrain@openttd.org> | 2021-04-21 19:42:42 +0200 |
|---|---|---|
| committer | Patric Stout <github@truebrain.nl> | 2021-04-21 22:48:11 +0200 |
| commit | 69355293aa2012f3dc778e88c76b71f0e65476cb (patch) | |
| tree | a1af9356bf98aeedfb4d1851b7f68abe0d9ade27 | |
| parent | e3150d0a85ad77f0fa5413f32794c9280c95286c (diff) | |
| download | openttd-69355293aa2012f3dc778e88c76b71f0e65476cb.tar.xz | |
Doc: split up which libraries are used for which situation
| -rw-r--r-- | COMPILING.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/COMPILING.md b/COMPILING.md index 5e642dc87..4e573f012 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -2,26 +2,27 @@ ## Required/optional libraries -The following libraries are used by OpenTTD for: +OpenTTD makes use of the following external libraries: -- zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, +- (encouraged) zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, heightmaps -- liblzo2: (de)compressing of old (pre 0.3.0) savegames -- liblzma: (de)compressing of savegames (1.1.0 and later) -- libpng: making screenshots and loading heightmaps +- (encouraged) liblzma: (de)compressing of savegames (1.1.0 and later) +- (encouraged) libpng: making screenshots and loading heightmaps +- (optional) liblzo2: (de)compressing of old (pre 0.3.0) savegames + +For Linux, the following additional libraries are used (for non-dedicated only): + +- libSDL2: hardware access (video, sound, mouse) - libfreetype: loading generic fonts and rendering them - libfontconfig: searching for fonts, resolving font names to actual fonts - libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and - natural sorting of strings (Linux only) -- libSDL2: hardware access (video, sound, mouse) (not required for Windows or macOS) + natural sorting of strings OpenTTD does not require any of the libraries to be present, but without liblzma you cannot open most recent savegames and without zlib you cannot open most older savegames or use the content downloading system. -Without libSDL/liballegro on non-Windows and non-macOS machines you have -no graphical user interface; you would be building a dedicated server. -## Windows: +## Windows You need Microsoft Visual Studio 2017 or more recent. |