forked from gemrb/gemrb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
95 lines (74 loc) · 3.56 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
BUILDING GEMRB WITH CMAKE
-------------------------
Tools you will need to build GemRB:
- cmake
- make
- a C++11 compatible compiler (g++, clang, MSVC and mingw are known to work)
Required dependencies:
- ZLib
- Python 3.3 or better, compiled with shared libraries
- ICONV
- SDL 1.2 or SDL 2.0+ (2.0.12 has a palette issue causing piles to have black outlines)
Optional dependencies:
- OpenAL (for sound; preferred)
- SDL_mixer / SDL2_mixer (lighter alternative sound driver)
- (lib)PNG (for the png importer plugin)
- libvorbis (for ogg/vorbis support)
- FreeType 2.4.2+ (for the TTF fonts plugin)
- (lib)VLC 2.0+ (for movies in some mac distributions of the games)
- OpenGL/OpenGLES drivers and libraries.
- GLEW libraries (Windows only, required for OpenGL support)
- Google Test (for automated tests)
When choosing SDL 1.2 or SDL 2.0.x, pass -DSDL_BACKEND=SDL (for 1.2) or
-DSDL_BACKEND=SDL2 (for 2.0) to cmake invocation. You can also invoke cmake
with -DSDL_BACKEND=Auto (default).
You can explicitly disable searching (and using) a particular optional
dependency by specifying -DUSE_foo=OFF flags (cumulative), where "foo" can be
any name from the above list.
Building GemRB on unix-like systems
-----------------------------------
The following commands will try to configure, make and install GemRB.
mkdir build
cd build
cmake .. [some options]
# Or, you can launch the interactive TUI and set options that way:
ccmake ..
make
make install
By default, GemRB is installed into /usr/local ("fhs"). You can pass -DLAYOUT
with "home" or "opt" to change the general layout and -DCMAKE_INSTALL_PREFIX
to change the install path prefix. Check the toplevel CMakeLists.txt to see
all the individual path components you can additionally alter.
Pass -DCMAKE_BUILD_TYPE=Debug to cmake if you want to create a debug build.
If you're on an exotic platform and get a lot of errors trying to build,
also pass -DDISABLE_WERROR=1, so warnings won't impede you. This option is
also suggested if you're making a source package.
If you want to build the OpenGL driver, first ensure you have a working SDL2
install and using SDL2 backend. Then, if you want the standard driver, pass
-DOPENGL_BACKEND=OpenGL and if you want the OpenGL ES driver, pass
-DOPENGL_BACKEND=GLES.
Building on a Raspberry Pi is supported (tested under Raspbian/Raspberry Pi OS).
The build system will automaticalluy add -DOPENGL_BACKEND=GLES, -DSDL_BACKEND=SDL2
to the build options. By default, the build will try to use the legacy/Broadcom GLES libraries in /opt/vc.
If your system is using the Mesa OpenGL driver with KMS support, pass -DDISABLE_VIDEOCORE
to disable the usage of the legacy/Broadcom drivers and you can use either OpenGL or GLES
for the OPENGL_BACKEND option.
Note: the Pi4 does not support the legacy/Broadcom GLES drivers, so you'll have to explicitely
pass -DDISABLE_VIDEOCORE to the 'cmake' build options.
Please let us know if you encounter any problems while building.
Building GemRB with MSVC
------------------------
Check this guide with detailed instructions for installing dependencies
and building GemRB: https://gemrb.github.io/MSVC-build.html
Building GemRB with mingw
-------------------------
The following commands will try to configure, make and install GemRB.
mkdir build
cd build
cmake .. -G "MinGW MakeFiles"
mingw32-make
mingw32-make install
By default, GemRB is installed into c:\Program Files\GemRB . Supporting
files are mostly installed into the same directory.
See the following for an extensive build walkthrough:
https://gemrb.github.io/MSYS2-build.html