Mercurial > molko
annotate INSTALL.md @ 502:ab2816f9551c
ui: start reworking on styles
While here, demonstrates how we can use a custom style on a button.
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 01 Mar 2023 10:34:12 +0100 |
parents | 67b52de5d3c0 |
children | e070fdcc592b |
rev | line source |
---|---|
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
1 Molko's Engine INSTALL |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
2 ====================== |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 Installation instructions. |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 Requirements |
417 | 7 ============ |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
417 | 9 - C11 compliant compiler. |
10 - [GNU Make][], Make build system. | |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
11 - [Jansson][], JSON parsing library. |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
12 - [SDL2][], Multimedia library. |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
13 - [SDL2_image][], Image loading addon for SDL2. |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
14 - [SDL2_mixer][], Audio addon for SDL2. |
417 | 15 - [SDL2_ttf][], Fonts addon for SDL2. |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
17 Molko's Engine is mostly written in pure C99 with a very limited POSIX |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
18 extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
19 missing fallback implementations are provided. |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
20 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
21 Supported platforms |
417 | 22 =================== |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
23 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
24 The project was successfully tested on the following platforms and their |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
25 architectures. |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
26 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
27 - Windows (MinGW-w64, VS2019). |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
28 - Linux (musl/amd64, musl/aarch64, glibc/amd64). |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
29 - FreeBSD (amd64). |
417 | 30 - OpenBSD (amd64). |
31 - macOS | |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
32 |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 Basic installation |
417 | 34 ================== |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 Quick install. |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 |
417 | 38 $ bsdtar -xvf molko-x.y.z-tar.xz |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 $ cd molko-x.y.z |
417 | 40 $ make |
41 # sudo make install | |
90
a6d6497adb60
make: cleanup a bit and add appropriate dependencies
David Demelier <markand@malikania.fr>
parents:
89
diff
changeset
|
42 |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
43 Available options |
417 | 44 ================= |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
45 |
417 | 46 The following make variables as available: |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
47 |
417 | 48 - `WITH_DEBUG`: Disable optimizations and turn on debug symbols (default: no). |
305
3675021fa6e5
make: add fakeroot support
David Demelier <markand@malikania.fr>
parents:
90
diff
changeset
|
49 |
417 | 50 The following make variables changes installation directories: |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
51 |
417 | 52 - `PREFIX`: Root install path (default: /usr/local). |
53 - `LIBDIR`: Libraries directory (default: $PREFIX/lib). | |
54 - `INCDIR`: C header directory (default: $PREFIX/include). | |
55 | |
56 Booleans options can be set to `yes` or `no` (case sensitive). | |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
57 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
58 Platform: macOS |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
59 --------------- |
305
3675021fa6e5
make: add fakeroot support
David Demelier <markand@malikania.fr>
parents:
90
diff
changeset
|
60 |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
61 The recommended way to build under macOS is to install dependencies through |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
62 [brew][] and compile using XCode or command line generated makefiles. |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
63 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
64 You will need the following packages: |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
65 |
417 | 66 - jansson |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
67 - sdl2 |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
68 - sdl2_image |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
69 - sdl2_mixer |
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
70 - sdl2_ttf |
307
363024b76da7
make: create install-data rather than fakeroot
David Demelier <markand@malikania.fr>
parents:
305
diff
changeset
|
71 |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 Platform: Windows |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 ----------------- |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
75 On Windows, [MSYS2][] and Visual Studio are supported. |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
77 ### MSYS2 |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 Once you have MSYS2 installed, simply install the following packages from the |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 appropriate MinGW shell prior to the chapter above. |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 - *make* |
417 | 83 - *mingw-w64-clang-x86_64-gcc* |
84 - *mingw-w64-clang-x86_64-SDL2* | |
85 - *mingw-w64-clang-x86_64-SDL2_image* | |
86 - *mingw-w64-clang-x86_64-SDL2_mixer* | |
87 - *mingw-w64-clang-x86_64-SDL2_ttf* | |
88 - *mingw-w64-clang-x86_64-jansson* | |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 |
89
30baadb6f6a2
core: add a panic_state in the adventure, continue #2484 @2h
David Demelier <markand@malikania.fr>
parents:
84
diff
changeset
|
90 Note: replace `x86_64` with `i686` if you have a deprecated system or if you |
30baadb6f6a2
core: add a panic_state in the adventure, continue #2484 @2h
David Demelier <markand@malikania.fr>
parents:
84
diff
changeset
|
91 have issues while debugging (MinGW-w64 and/or gdb have known issues in |
30baadb6f6a2
core: add a panic_state in the adventure, continue #2484 @2h
David Demelier <markand@malikania.fr>
parents:
84
diff
changeset
|
92 this area). |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 |
417 | 94 Remove `clang-` prefix if you need to use gcc for some reasons. |
95 | |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
96 ### Visual Studio |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
97 |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
98 On Visual Studio you will need to download or build libraries yourself. It is |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
99 recommended to install all of them in a same directory and hierarchy as |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
100 following: |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
101 |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
102 - <dir>/bin |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
103 - <dir>/lib |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
104 - <dir>/include |
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
105 |
417 | 106 Building with Visual Studio is only supported through `clang-cl` which should be |
107 installed as individual component from the Visual Studio installer. You also | |
108 need a POSIX compliant toolset such as [MSYS2][] and add it to your path. | |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
109 |
326
06782f7888f3
misc: update meta files
David Demelier <markand@malikania.fr>
parents:
315
diff
changeset
|
110 [brew][]: http://brew.sh |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
111 [CMake][]: http://cmake.org |
25
0d5ecefcccd3
molko-map: reimplement using JSON as it is supported by tiled, closes #2448 @4h
David Demelier <markand@malikania.fr>
parents:
17
diff
changeset
|
112 [Jansson][]: http://www.digip.org/jansson |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
113 [MSYS2]: http://www.msys2.org |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 [SDL2]: http://libsdl.org |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 [SDL2_image]: https://www.libsdl.org/projects/SDL_image |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
116 [SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 [SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf |
315
3bfaaf5342a9
cmake: add support for Visual Studio 2019
David Demelier <markand@malikania.fr>
parents:
308
diff
changeset
|
118 [gettext]: https://www.gnu.org/software/gettext |