Shared-libraries-(buildfiles).md

   1 darkplaces/Xonotic on Linux uses system libraries. For Windows and macOS external dlls and dylibs are needed. Those reside in xonotic/misc/buildfiles
   2
   3 Because at the time of writing there is no automatism to build or update the games dependencies for those 2 platforms and the current dlls/dylibs are VERY outdated and thus also contain vulnerabilities, this page should document on where to obtain or how to build them, retaining API compatibility to darkplaces and also older OS platform versions like Windows XP.
   4
   5 For Windows, all libraries can/should be obtained from https://packages.msys2.org/ [1] with the exception of an official DLL release from the upstream being available (this is the case for jpeg-turbo and freetype) or if it has to be compiled on under Windows for some reason (eg. libcurl for Schannel (Windows crypto for HTTPS) support).
   6
   7 A handy tool to check dll deps on Windows is https://github.com/lucasg/Dependencies
   8
   9 TODO: macOS
  10
  11 # libcurl
  12 libcurl is used for downloading *.pk3 files from servers
  13
  14 ### Windows
  15
  16 ```
  17 git clone -b curl-7_80_0 https://github.com/curl/curl || true
  18 curl -o x86_64-w64-mingw32.cmake https://raw.githubusercontent.com/zyga/cmake-toolchains/master/Toolchain-Ubuntu-mingw64.cmake
  19 d0=$(pwd)
  20 rm -rf build
  21 mkdir build
  22 cd build
  23 cmake -DCMAKE_TOOLCHAIN_FILE="$d0/x86_64-w64-mingw32.cmake" -DCMAKE_INSTALL_PREFIX="$d0/out" -DCURL_USE_SCHANNEL=YES -G"Unix Makefiles" "$d0/curl"
  24 make
  25 make install
  26 cd "$d0"
  27 cp out/bin/libcurl.dll ~/Games/xonotic/misc/buildfiles/win64/libcurl-4.dll
  28 ```
  29
  30 ### macOS
  31 Darkplaces loads `libcurl.4.dylib` or `libcurl.3.dylib` or `libcurl.2.dylib`
  32
  33 # libjpeg-turbo
  34 libjpeg-turbo is needed to display jpeg images/textures
  35
  36 ### Windows
  37
  38 ```
  39 git clone https://github.com/libjpeg-turbo/libjpeg-turbo.git || true
  40 curl -o x86_64-w64-mingw32.cmake https://raw.githubusercontent.com/zyga/cmake-toolchains/master/Toolchain-Ubuntu-mingw64.cmake
  41 d0=$(pwd)
  42 rm -rf build
  43 mkdir build
  44 cd build
  45 cmake -DCMAKE_TOOLCHAIN_FILE="$d0/x86_64-w64-mingw32.cmake" -DCMAKE_SYSTEM_PROCESSOR=x86_64 -DCMAKE_INSTALL_PREFIX="$d0/out" -G"Unix Makefiles" "$d0/libjpeg-turbo"
  46 make
  47 make install
  48 cd "$d0"
  49 cp out/bin/libjpeg-62.dll ~/Games/xonotic/misc/buildfiles/win64/libjpeg.dll
  50 ```
  51
  52 ### macOS
  53 Darkplaces loads `libjpeg.62.dylib`
  54
  55 # zlib
  56 zlib is required to read *.pk3 files. Also it is a dependency of libpng and probably some other libraries.
  57
  58 ### Windows
  59 Darkplaces loads: ifdef ZLIB_USES_WINAPI `zlibwapi.dll` or `zlib.dll` else `zlib1.dll`. We use `zlib1.dll`!
  60
  61 Obtainment instructions:
  62 * download as MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-zlib
  63 * use dll from `bin` folder
  64
  65 Cross-compiling:
  66
  67 ```
  68 ZLIBVER="1.2.11"
  69 curl -L -o zlib-$ZLIBVER.tar.xz https://zlib.net/zlib-$ZLIBVER.tar.xz || true
  70 tar -xf zlib-$ZLIBVER.tar.xz
  71 rm zlib-$ZLIBVER.tar.xz
  72
  73 curl -o x86_64-w64-mingw32.cmake https://raw.githubusercontent.com/zyga/cmake-toolchains/master/Toolchain-Ubuntu-mingw64.cmake
  74 d0=$(pwd)
  75 rm -rf build
  76 mkdir build
  77 cd build
  78 cmake -DCMAKE_TOOLCHAIN_FILE="$d0/x86_64-w64-mingw32.cmake" -DBUILD_SHARED_LIBS=true -DCMAKE_SYSTEM_PROCESSOR=x86_64 -DCMAKE_INSTALL_PREFIX="$d0/out" -G"Unix Makefiles" "$d0/zlib-$ZLIBVER"
  79 make
  80 make install
  81 cd "$d0"
  82 cp out/bin/libzlib1.dll ~/Games/xonotic/misc/buildfiles/win64/zlib1.dll
  83 ```
  84
  85 ### macOS
  86 Darkplaces loads `libz.dylib`
  87
  88 # libpng
  89 libpng is needed to display png images/textures
  90
  91 ### Windows
  92 Darkplaces loads `libpng16.dll` or `libpng16-16.dll` or `libpng15-15.dll` or `libpng15.dll` or `libpng14-14.dll` or `libpng14.dll` or `libpng12.dll`
  93
  94 Obtainment instructions:
  95 * be sure to use a 1.16.X release
  96 * download MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-libpng
  97 * use dll from `bin` folder
  98
  99 ### macOS
 100 Darkplaces loads `libpng16.16.dylib` or `libpng15.15.dylib` or `libpng14.14.dylib` or `libpng12.0.dylib`
 101
 102 # libfreetype
 103 Required for the Xolonium font
 104
 105 ### Windows
 106 Darkplaces loads: `libfreetype-6.dll` or `freetype6.dll`
 107
 108 ```
 109 FTVER="2.11.1"
 110 curl -L -o freetype-$FTVER.tar.xz https://download.savannah.gnu.org/releases/freetype/freetype-$FTVER.tar.xz || true
 111 tar -xf freetype-$FTVER.tar.xz
 112 rm freetype-$FTVER.tar.xz
 113
 114 curl -o x86_64-w64-mingw32.cmake https://raw.githubusercontent.com/zyga/cmake-toolchains/master/Toolchain-Ubuntu-mingw64.cmake
 115 d0=$(pwd)
 116 rm -rf build
 117 mkdir build
 118 cd build
 119 cmake -DCMAKE_TOOLCHAIN_FILE="$d0/x86_64-w64-mingw32.cmake" -DBUILD_SHARED_LIBS=true -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_PROCESSOR=x86_64 -DCMAKE_INSTALL_PREFIX="$d0/out" -G"Unix Makefiles" "$d0/freetype-$FTVER"
 120 make
 121 make install
 122 cd "$d0"
 123 cp out/bin/libfreetype.dll ~/Games/xonotic/misc/buildfiles/win64/libfreetype-6.dll
 124 ```
 125
 126 ### macOS
 127 Darkplaces loads: `libfreetype.6.dylib` or `libfreetype.dylib`
 128
 129 # libvorbis + libvorbisfile + libvorbisenc
 130 libvorbis + libvorbisfile are used to play .ogg audio files while libvorbis + libvorbisenc is used for the audio in video capturing (cl_capturevideo)
 131
 132 ### Windows
 133 Darkplaces loads `libvorbis-0.dll` or `libvorbis.dll` or `vorbis.dll` and `libvorbisfile-3.dll` or `libvorbisfile.dll` or `vorbisfile.dll` and `libvorbisenc-2.dll` or `vorbisenc-2.dll` or `vorbisenc.dll`
 134
 135 Obtainment instructions:
 136 * download MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-libvorbis
 137 * use dll from `bin` folder
 138
 139 ### macOS
 140 Darkplaces loads `libvorbis.dylib` and `libvorbisfile.dylib`
 141
 142 # libtheora
 143 libtheora is used for the video in cl_capturevideo
 144 libtheoraenc/libtheoradec are not needed, they are the newer API; darkplaces uses the legacy pre 1.0 API (libtheora).
 145
 146 ### Windows
 147 Darkplaces loads `libtheora-0.dll` or `theora-0.dll` or `theora.dll`
 148
 149 Obtainment instructions:
 150 * download MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-libtheora
 151 * use dll from `bin` folder
 152
 153 ### macOS
 154 Darkplaces loads `libtheora.dylib`
 155
 156 # libogg
 157 libogg is used for the container in cl_capturevideo
 158
 159 ### Windows
 160 Darkplaces loads `libogg-0.dll` or `libogg.dll` or `ogg.dll`
 161
 162 Obtainment instructions:
 163 * download MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-libogg
 164 * use dll from `bin` folder
 165
 166 ### macOS
 167 Darkplaces loads `libogg.dylib`
 168
 169 # libd0_blind_id-0 & libd0_rijndael-0
 170 Internal project, see https://gitlab.com/xonotic/d0_blind_id
 171
 172 ### Linux
 173
 174 `LDFLAGS='-L$HOME/Games/xonotic/misc/builddeps/linux64/gmp/lib' CPPFLAGS='-I$HOME/Games/xonotic/misc/builddeps/linux64/gmp/include' ./configure --prefix=$HOME/Games/xonotic/misc/builddeps/linux64/d0_blind_id  --enable-static --disable-shared --with-pic`
 175
 176 # libgmp
 177 A dependency of libd0_blind_id-0
 178
 179 ### Linux
 180
 181 `./configure --prefix=$HOME/Games/xonotic/misc/builddeps/linux64/gmp --enable-static --disable-shared --with-pic --enable-fat`
 182
 183 ### Windows
 184 libd0_blind_id-0 loads `libgmp-10.dll`
 185
 186 Obtainment instructions:
 187 * download as MSYS2 Package [1] in x86 and x64 versions: https://packages.msys2.org/base/mingw-w64-gmp
 188 * use dll from `bin` folder
 189
 190 # libode
 191 Is not loaded under Windows and crashes the game if it is and a map is loaded up.
 192 Also it is not statically linked and thus requires libstdc++-6.dll and libgcc_s_sjlj-1.dll.
 193
 194 ### Linux:
 195
 196 `./configure --enable-static --disable-shared --with-libccd=internal --enable-double-precision --prefix=$HOME/Games/xonotic/misc/builddeps/linux64/ode --with-pic`
 197
 198 # libavw
 199 *Note:* Old and not used in Xonotic but also not disabled :) Adding this for the sake of completeness.
 200
 201 ### Windows
 202 Darkplaces loads: `libavw.dll`
 203
 204 Source code: https://github.com/paulvortex/DpLibAVW
 205
 206 ### macOS
 207 Darkplaces loads: `libavw.dylib`