Mercurial > molko

comparison INSTALL.md @ 429:67b52de5d3c0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: update INSTALL
author David Demelier <markand@malikania.fr>
date Sat, 15 Oct 2022 15:56:09 +0200
parents 7ac4b10eedbe
children e070fdcc592b
comparison
equal deleted inserted replaced
428:26d23999a54b 429:67b52de5d3c0
11 - [Jansson][], JSON parsing library. 11 - [Jansson][], JSON parsing library.
12 - [SDL2][], Multimedia library. 12 - [SDL2][], Multimedia library.
13 - [SDL2_image][], Image loading addon for SDL2. 13 - [SDL2_image][], Image loading addon for SDL2.
14 - [SDL2_mixer][], Audio addon for SDL2. 14 - [SDL2_mixer][], Audio addon for SDL2.
15 - [SDL2_ttf][], Fonts addon for SDL2. 15 - [SDL2_ttf][], Fonts addon for SDL2.
16 - [zstd][], For compression (optional).
17 - [libzip][], For ZIP vfs support (optional).
18 16
19 Molko's Engine is mostly written in pure C99 with a very limited POSIX 17 Molko's Engine is mostly written in pure C99 with a very limited POSIX
20 extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is 18 extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is
21 missing fallback implementations are provided. 19 missing fallback implementations are provided.
22 20
45 Available options 43 Available options
46 ================= 44 =================
47 45
48 The following make variables as available: 46 The following make variables as available:
49 47
50 - `WITH_ZSTD`: Enable map and tileset compression through [zstd][] (default:
51 yes).
52 - `WITH_ZIP`: Enable ZIP file support through VFS API (default: yes).
53 - `WITH_DEBUG`: Disable optimizations and turn on debug symbols (default: no). 48 - `WITH_DEBUG`: Disable optimizations and turn on debug symbols (default: no).
54 49
55 The following make variables changes installation directories: 50 The following make variables changes installation directories:
56 51
57 - `PREFIX`: Root install path (default: /usr/local). 52 - `PREFIX`: Root install path (default: /usr/local).
71 - jansson 66 - jansson
72 - sdl2 67 - sdl2
73 - sdl2_image 68 - sdl2_image
74 - sdl2_mixer 69 - sdl2_mixer
75 - sdl2_ttf 70 - sdl2_ttf
76 - zstd (only if `WITH_ZSTD` is enabled)
77 - libzip (only if `WITH_ZIP` is enabled)
78 71
79 Platform: Windows 72 Platform: Windows
80 ----------------- 73 -----------------
81 74
82 On Windows, [MSYS2][] and Visual Studio are supported. 75 On Windows, [MSYS2][] and Visual Studio are supported.
91 - *mingw-w64-clang-x86_64-SDL2* 84 - *mingw-w64-clang-x86_64-SDL2*
92 - *mingw-w64-clang-x86_64-SDL2_image* 85 - *mingw-w64-clang-x86_64-SDL2_image*
93 - *mingw-w64-clang-x86_64-SDL2_mixer* 86 - *mingw-w64-clang-x86_64-SDL2_mixer*
94 - *mingw-w64-clang-x86_64-SDL2_ttf* 87 - *mingw-w64-clang-x86_64-SDL2_ttf*
95 - *mingw-w64-clang-x86_64-jansson* 88 - *mingw-w64-clang-x86_64-jansson*
96 - *mingw-w64-clang-x86_64-zstd* (only if `WITH_ZSTD` is enabled)
97 - *mingw-w64-clang-x86_64-zip* (only if `WITH_ZSTD` is enabled)
98 89
99 Note: replace `x86_64` with `i686` if you have a deprecated system or if you 90 Note: replace `x86_64` with `i686` if you have a deprecated system or if you
100 have issues while debugging (MinGW-w64 and/or gdb have known issues in 91 have issues while debugging (MinGW-w64 and/or gdb have known issues in
101 this area). 92 this area).
102 93
123 [SDL2]: http://libsdl.org 114 [SDL2]: http://libsdl.org
124 [SDL2_image]: https://www.libsdl.org/projects/SDL_image 115 [SDL2_image]: https://www.libsdl.org/projects/SDL_image
125 [SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer 116 [SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer
126 [SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf 117 [SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf
127 [gettext]: https://www.gnu.org/software/gettext 118 [gettext]: https://www.gnu.org/software/gettext
128 [zstd]: http://facebook.github.io/zstd