latex/md_README.tex

   1 \href{https://travis-ci.org/minetest/minetest}{\tt } \href{https://hosted.weblate.org/engage/minetest/?utm_source=widget}{\tt } \href{https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html}{\tt }
   2
   3 Minetest is a free open-\/source voxel game engine with easy modding and game creation.
   4
   5 Copyright (C) 2010-\/2019 Perttu Ahola \href{mailto:celeron55@gmail.com}{\tt celeron55@gmail.\+com} and contributors (see source file comments and the version control log)
   6
   7 \subsection*{In case you downloaded the source code }
   8
   9 If you downloaded the Minetest Engine source code in which this file is contained, you probably want to download the \href{https://github.com/minetest/minetest_game/}{\tt Minetest Game} project too. See its R\+E\+A\+D\+M\+E.\+txt for more information.
  10
  11 \subsection*{Table of Contents }
  12
  13
  14 \begin{DoxyEnumerate}
  15 \item \href{#further-documentation}{\tt Further Documentation}
  16 \item \href{#default-controls}{\tt Default Controls}
  17 \item \href{#paths}{\tt Paths}
  18 \item \href{#configuration-file}{\tt Configuration File}
  19 \item \href{#command-line-options}{\tt Command-\/line Options}
  20 \item \href{#compiling}{\tt Compiling}
  21 \item \href{#docker}{\tt Docker}
  22 \item \href{#version-scheme}{\tt Version Scheme}
  23 \end{DoxyEnumerate}
  24
  25 \subsection*{Further documentation }
  26
  27
  28 \begin{DoxyItemize}
  29 \item Website\+: \href{http://minetest.net/}{\tt http\+://minetest.\+net/}
  30 \item Wiki\+: \href{http://wiki.minetest.net/}{\tt http\+://wiki.\+minetest.\+net/}
  31 \item Developer wiki\+: \href{http://dev.minetest.net/}{\tt http\+://dev.\+minetest.\+net/}
  32 \item Forum\+: \href{http://forum.minetest.net/}{\tt http\+://forum.\+minetest.\+net/}
  33 \item Git\+Hub\+: \href{https://github.com/minetest/minetest/}{\tt https\+://github.\+com/minetest/minetest/}
  34 \item \href{doc/}{\tt doc/} directory of source distribution
  35 \end{DoxyItemize}
  36
  37 \subsection*{Default controls }
  38
  39 All controls are re-\/bindable using settings. Some can be changed in the key config dialog in the settings tab.
  40
  41 \tabulinesep=1mm
  42 \begin{longtabu} spread 0pt [c]{*{2}{|X[-1]}|}
  43 \hline
  44 \rowcolor{\tableheadbgcolor}\textbf{ Button }&\textbf{ Action  }\\\cline{1-2}
  45 \endfirsthead
  46 \hline
  47 \endfoot
  48 \hline
  49 \rowcolor{\tableheadbgcolor}\textbf{ Button }&\textbf{ Action  }\\\cline{1-2}
  50 \endhead
  51 Move mouse &Look around \\\cline{1-2}
  52 W, A, S, D &Move \\\cline{1-2}
  53 Space &Jump/move up \\\cline{1-2}
  54 Shift &Sneak/move down \\\cline{1-2}
  55 Q &Drop itemstack \\\cline{1-2}
  56 Shift + Q &Drop single item \\\cline{1-2}
  57 Left mouse button &Dig/punch/take item \\\cline{1-2}
  58 Right mouse button &Place/use \\\cline{1-2}
  59 Shift + right mouse button &Build (without using) \\\cline{1-2}
  60 I &Inventory menu \\\cline{1-2}
  61 Mouse wheel &Select item \\\cline{1-2}
  62 0-\/9 &Select item \\\cline{1-2}
  63 Z &Zoom (needs zoom privilege) \\\cline{1-2}
  64 T &Chat \\\cline{1-2}
  65 / &Command \\\cline{1-2}
  66 Esc &Pause menu/abort/exit (pauses only singleplayer game) \\\cline{1-2}
  67 R &Enable/disable full range view \\\cline{1-2}
  68 + &Increase view range \\\cline{1-2}
  69 -\/ &Decrease view range \\\cline{1-2}
  70 K &Enable/disable fly mode (needs fly privilege) \\\cline{1-2}
  71 P &Enable/disable pitch move mode \\\cline{1-2}
  72 J &Enable/disable fast mode (needs fast privilege) \\\cline{1-2}
  73 H &Enable/disable noclip mode (needs noclip privilege) \\\cline{1-2}
  74 E &Move fast in fast mode \\\cline{1-2}
  75 F1 &Hide/show H\+UD \\\cline{1-2}
  76 F2 &Hide/show chat \\\cline{1-2}
  77 F3 &Disable/enable fog \\\cline{1-2}
  78 F4 &Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds) \\\cline{1-2}
  79 F5 &Cycle through debug information screens \\\cline{1-2}
  80 F6 &Cycle through profiler info screens \\\cline{1-2}
  81 F7 &Cycle through camera modes \\\cline{1-2}
  82 F9 &Cycle through minimap modes \\\cline{1-2}
  83 Shift + F9 &Change minimap orientation \\\cline{1-2}
  84 F10 &Show/hide console \\\cline{1-2}
  85 F12 &Take screenshot \\\cline{1-2}
  86 \end{longtabu}
  87 \subsection*{Paths }
  88
  89 Locations\+:
  90
  91
  92 \begin{DoxyItemize}
  93 \item {\ttfamily bin} -\/ Compiled binaries
  94 \item {\ttfamily share} -\/ Distributed read-\/only data
  95 \item {\ttfamily user} -\/ User-\/created modifiable data
  96 \end{DoxyItemize}
  97
  98 Where each location is on each platform\+:
  99
 100
 101 \begin{DoxyItemize}
 102 \item Windows .zip / R\+U\+N\+\_\+\+I\+N\+\_\+\+P\+L\+A\+CE source\+:
 103 \begin{DoxyItemize}
 104 \item {\ttfamily bin} = {\ttfamily bin}
 105 \item {\ttfamily share} = {\ttfamily .}
 106 \item {\ttfamily user} = {\ttfamily .}
 107 \end{DoxyItemize}
 108 \item Windows installed\+:
 109 \begin{DoxyItemize}
 110 \item {\ttfamily bin} = {\ttfamily C\+:\textbackslash{}Program Files\textbackslash{}Minetest\textbackslash{}bin (Depends on the install location)}
 111 \item {\ttfamily share} = {\ttfamily C\+:\textbackslash{}Program Files\textbackslash{}Minetest (Depends on the install location)}
 112 \item {\ttfamily user} = {\ttfamily A\+P\+P\+D\+A\+TA\%\textbackslash{}Minetest}
 113 \end{DoxyItemize}
 114 \item Linux installed\+:
 115 \begin{DoxyItemize}
 116 \item {\ttfamily bin} = {\ttfamily /usr/bin}
 117 \item {\ttfamily share} = {\ttfamily /usr/share/minetest}
 118 \item {\ttfamily user} = {\ttfamily $\sim$/.minetest}
 119 \end{DoxyItemize}
 120 \item mac\+OS\+:
 121 \begin{DoxyItemize}
 122 \item {\ttfamily bin} = {\ttfamily Contents/\+Mac\+OS}
 123 \item {\ttfamily share} = {\ttfamily Contents/\+Resources}
 124 \item {\ttfamily user} = {\ttfamily Contents/\+User OR $\sim$/\+Library/\+Application Support/minetest}
 125 \end{DoxyItemize}
 126 \end{DoxyItemize}
 127
 128 Worlds can be found as separate folders in\+: {\ttfamily user/worlds/}
 129
 130 \subsection*{Configuration file }
 131
 132
 133 \begin{DoxyItemize}
 134 \item Default location\+: {\ttfamily user/minetest.\+conf}
 135 \item This file is created by closing Minetest for the first time.
 136 \item A specific file can be specified on the command line\+: {\ttfamily -\/-\/config $<$path-\/to-\/file$>$}
 137 \item A run-\/in-\/place build will look for the configuration file in {\ttfamily location\+\_\+of\+\_\+exe/../minetest.conf} and also {\ttfamily location\+\_\+of\+\_\+exe/../../minetest.conf}
 138 \end{DoxyItemize}
 139
 140 \subsection*{Command-\/line options }
 141
 142
 143 \begin{DoxyItemize}
 144 \item Use {\ttfamily -\/-\/help}
 145 \end{DoxyItemize}
 146
 147 \subsection*{Compiling }
 148
 149 \subsubsection*{Compiling on G\+N\+U/\+Linux}
 150
 151 \paragraph*{Dependencies}
 152
 153 \tabulinesep=1mm
 154 \begin{longtabu} spread 0pt [c]{*{3}{|X[-1]}|}
 155 \hline
 156 \rowcolor{\tableheadbgcolor}\textbf{ Dependency }&\textbf{ Version }&\textbf{ Commentary  }\\\cline{1-3}
 157 \endfirsthead
 158 \hline
 159 \endfoot
 160 \hline
 161 \rowcolor{\tableheadbgcolor}\textbf{ Dependency }&\textbf{ Version }&\textbf{ Commentary  }\\\cline{1-3}
 162 \endhead
 163 G\+CC &4.\+9+ &Can be replaced with Clang 3.\+4+ \\\cline{1-3}
 164 C\+Make &2.\+6+ &\\\cline{1-3}
 165 Irrlicht &1.\+7.\+3+ &\\\cline{1-3}
 166 S\+Q\+Lite3 &3.\+0+ &\\\cline{1-3}
 167 Lua\+J\+IT &2.\+0+ &Bundled Lua 5.\+1 is used if not present \\\cline{1-3}
 168 G\+MP &5.\+0.\+0+ &Bundled mini-\/\+G\+MP is used if not present \\\cline{1-3}
 169 Json\+C\+PP &1.\+0.\+0+ &Bundled Json\+C\+PP is used if not present \\\cline{1-3}
 170 \end{longtabu}
 171 For Debian/\+Ubuntu users\+: \begin{DoxyVerb}sudo apt install g++ make libc6-dev libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev
 172 \end{DoxyVerb}
 173
 174
 175 For Fedora users\+: \begin{DoxyVerb}sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libcurl-devel openal-soft-devel libvorbis-devel libXxf86vm-devel libogg-devel freetype-devel mesa-libGL-devel zlib-devel jsoncpp-devel irrlicht-devel bzip2-libs gmp-devel sqlite-devel luajit-devel leveldb-devel ncurses-devel doxygen spatialindex-devel bzip2-devel
 176 \end{DoxyVerb}
 177
 178
 179 For Arch users\+: \begin{DoxyVerb}sudo pacman -S base-devel libcurl-gnutls cmake libxxf86vm irrlicht libpng sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses
 180 \end{DoxyVerb}
 181
 182
 183 For Alpine users\+: \begin{DoxyVerb}sudo apk add build-base irrlicht-dev cmake bzip2-dev libpng-dev jpeg-dev libxxf86vm-dev mesa-dev sqlite-dev libogg-dev libvorbis-dev openal-soft-dev curl-dev freetype-dev zlib-dev gmp-dev jsoncpp-dev luajit-dev
 184 \end{DoxyVerb}
 185
 186
 187 \paragraph*{Download}
 188
 189 You can install Git for easily keeping your copy up to date. If you don’t want Git, read below on how to get the source without Git. This is an example for installing Git on Debian/\+Ubuntu\+: \begin{DoxyVerb}sudo apt install git
 190 \end{DoxyVerb}
 191
 192
 193 For Fedora users\+: \begin{DoxyVerb}sudo dnf install git
 194 \end{DoxyVerb}
 195
 196
 197 Download source (this is the U\+RL to the latest of source repository, which might not work at all times) using Git\+: \begin{DoxyVerb}git clone --depth 1 https://github.com/minetest/minetest.git
 198 cd minetest
 199 \end{DoxyVerb}
 200
 201
 202 Download minetest\+\_\+game (otherwise only the \char`\"{}\+Minimal development test\char`\"{} game is available) using Git\+: \begin{DoxyVerb}git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 203 \end{DoxyVerb}
 204
 205
 206 Download source, without using Git\+: \begin{DoxyVerb}wget https://github.com/minetest/minetest/archive/master.tar.gz
 207 tar xf master.tar.gz
 208 cd minetest-master
 209 \end{DoxyVerb}
 210
 211
 212 Download minetest\+\_\+game, without using Git\+: \begin{DoxyVerb}cd games/
 213 wget https://github.com/minetest/minetest_game/archive/master.tar.gz
 214 tar xf master.tar.gz
 215 mv minetest_game-master minetest_game
 216 cd ..
 217 \end{DoxyVerb}
 218
 219
 220 \paragraph*{Build}
 221
 222 Build a version that runs directly from the source directory\+: \begin{DoxyVerb}cmake . -DRUN_IN_PLACE=TRUE
 223 make -j$(nproc)
 224 \end{DoxyVerb}
 225
 226
 227 Run it\+: \begin{DoxyVerb}./bin/minetest
 228 \end{DoxyVerb}
 229
 230
 231
 232 \begin{DoxyItemize}
 233 \item Use {\ttfamily cmake . -\/\+LH} to see all C\+Make options and their current state.
 234 \item If you want to install it system-\/wide (or are making a distribution package), you will want to use {\ttfamily -\/\+D\+R\+U\+N\+\_\+\+I\+N\+\_\+\+P\+L\+A\+CE=F\+A\+L\+SE}.
 235 \item You can build a bare server by specifying {\ttfamily -\/\+D\+B\+U\+I\+L\+D\+\_\+\+S\+E\+R\+V\+ER=T\+R\+UE}.
 236 \item You can disable the client build by specifying {\ttfamily -\/\+D\+B\+U\+I\+L\+D\+\_\+\+C\+L\+I\+E\+NT=F\+A\+L\+SE}.
 237 \item You can select between Release and Debug build by {\ttfamily -\/\+D\+C\+M\+A\+K\+E\+\_\+\+B\+U\+I\+L\+D\+\_\+\+T\+Y\+PE=$<$Debug or Release$>$}.
 238 \begin{DoxyItemize}
 239 \item Debug build is slower, but gives much more useful output in a debugger.
 240 \end{DoxyItemize}
 241 \item If you build a bare server you don\textquotesingle{}t need to have Irrlicht installed.
 242 \begin{DoxyItemize}
 243 \item In that case use {\ttfamily -\/\+D\+I\+R\+R\+L\+I\+C\+H\+T\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+D\+IR=/the/irrlicht/source}.
 244 \end{DoxyItemize}
 245 \end{DoxyItemize}
 246
 247 \subsubsection*{C\+Make options}
 248
 249 General options and their default values\+: \begin{DoxyVerb}BUILD_CLIENT=TRUE          - Build Minetest client
 250 BUILD_SERVER=FALSE         - Build Minetest server
 251 CMAKE_BUILD_TYPE=Release   - Type of build (Release vs. Debug)
 252     Release                - Release build
 253     Debug                  - Debug build
 254     SemiDebug              - Partially optimized debug build
 255     RelWithDebInfo         - Release build with debug information
 256     MinSizeRel             - Release build with -Os passed to compiler to make executable as small as possible
 257 ENABLE_CURL=ON             - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 258 ENABLE_CURSES=ON           - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
 259 ENABLE_FREETYPE=ON         - Build with FreeType2; Allows using TTF fonts
 260 ENABLE_GETTEXT=ON          - Build with Gettext; Allows using translations
 261 ENABLE_GLES=OFF            - Build for OpenGL ES instead of OpenGL (requires support by Irrlicht)
 262 ENABLE_LEVELDB=ON          - Build with LevelDB; Enables use of LevelDB map backend
 263 ENABLE_POSTGRESQL=ON       - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
 264 ENABLE_REDIS=ON            - Build with libhiredis; Enables use of Redis map backend
 265 ENABLE_SPATIAL=ON          - Build with LibSpatial; Speeds up AreaStores
 266 ENABLE_SOUND=ON            - Build with OpenAL, libogg & libvorbis; in-game sounds
 267 ENABLE_LUAJIT=ON           - Build with LuaJIT (much faster than non-JIT Lua)
 268 ENABLE_SYSTEM_GMP=ON       - Use GMP from system (much faster than bundled mini-gmp)
 269 ENABLE_SYSTEM_JSONCPP=OFF  - Use JsonCPP from system
 270 OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference
 271 RUN_IN_PLACE=FALSE         - Create a portable install (worlds, settings etc. in current directory)
 272 USE_GPROF=FALSE            - Enable profiling using GProf
 273 VERSION_EXTRA=             - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 274 \end{DoxyVerb}
 275
 276
 277 Library specific options\+: \begin{DoxyVerb}BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
 278 BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
 279 CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 280 CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 281 CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 282 EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 283 EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
 284 FREETYPE_INCLUDE_DIR_freetype2  - Only if building with FreeType 2; directory that contains an freetype directory with files such as ftimage.h in it
 285 FREETYPE_INCLUDE_DIR_ft2build   - Only if building with FreeType 2; directory that contains ft2build.h
 286 FREETYPE_LIBRARY                - Only if building with FreeType 2; path to libfreetype.a/libfreetype.so/freetype.lib
 287 FREETYPE_DLL                    - Only if building with FreeType 2 on Windows; path to libfreetype.dll
 288 GETTEXT_DLL                     - Only when building with gettext on Windows; path to libintl3.dll
 289 GETTEXT_ICONV_DLL               - Only when building with gettext on Windows; path to libiconv2.dll
 290 GETTEXT_INCLUDE_DIR             - Only when building with gettext; directory that contains iconv.h
 291 GETTEXT_LIBRARY                 - Only when building with gettext on Windows; path to libintl.dll.a
 292 GETTEXT_MSGFMT                  - Only when building with gettext; path to msgfmt/msgfmt.exe
 293 IRRLICHT_DLL                    - Only on Windows; path to Irrlicht.dll
 294 IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h
 295 IRRLICHT_LIBRARY                - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
 296 LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 297 LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
 298 LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 299 PostgreSQL_INCLUDE_DIR          - Only when building with PostgreSQL; directory that contains libpq-fe.h
 300 PostgreSQL_LIBRARY              - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib
 301 REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
 302 REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
 303 SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
 304 SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
 305 LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 306 LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 307 MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
 308 OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
 309 OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
 310 OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
 311 OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
 312 OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
 313 OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
 314 OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
 315 OPENGLES2_LIBRARY               - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
 316 SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
 317 SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
 318 VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
 319 VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 320 VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
 321 VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 322 VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 323 XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
 324 ZLIB_DLL                        - Only on Windows; path to zlib1.dll
 325 ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
 326 ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlib.lib
 327 \end{DoxyVerb}
 328
 329
 330 \subsubsection*{Compiling on Windows}
 331
 332 \subsubsection*{Requirements}
 333
 334
 335 \begin{DoxyItemize}
 336 \item \href{https://visualstudio.microsoft.com}{\tt Visual Studio 2015 or newer}
 337 \item \href{https://cmake.org/download/}{\tt C\+Make}
 338 \item \href{https://github.com/Microsoft/vcpkg}{\tt vcpkg}
 339 \item \href{https://git-scm.com/downloads}{\tt Git}
 340 \end{DoxyItemize}
 341
 342 \subsubsection*{Compiling and installing the dependencies}
 343
 344 It is highly recommended to use vcpkg as package manager.
 345
 346 \paragraph*{a) Using vcpkg to install dependencies}
 347
 348 After you successfully built vcpkg you can easily install the required libraries\+:
 349 \begin{DoxyCode}
 350 vcpkg install irrlicht zlib curl[winssl] openal-soft libvorbis libogg sqlite3 freetype luajit --triplet
 351        x64-windows
 352 \end{DoxyCode}
 353
 354
 355
 356 \begin{DoxyItemize}
 357 \item {\ttfamily curl} is optional, but required to read the serverlist, {\ttfamily curl\mbox{[}winssl\mbox{]}} is required to use the content store.
 358 \item {\ttfamily openal-\/soft}, {\ttfamily libvorbis} and {\ttfamily libogg} are optional, but required to use sound.
 359 \item {\ttfamily freetype} is optional, it allows true-\/type font rendering.
 360 \item {\ttfamily luajit} is optional, it replaces the integrated Lua interpreter with a faster just-\/in-\/time interpreter.
 361 \end{DoxyItemize}
 362
 363 There are other optional libraries, but they are not tested if they can build and link correctly.
 364
 365 Use {\ttfamily -\/-\/triplet} to specify the target triplet, e.\+g. {\ttfamily x64-\/windows} or {\ttfamily x86-\/windows}.
 366
 367 \paragraph*{b) Compile the dependencies on your own}
 368
 369 This is outdated and not recommended. Follow the instructions on \href{https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build}{\tt https\+://dev.\+minetest.\+net/\+Build\+\_\+\+Win32\+\_\+\+Minetest\+\_\+including\+\_\+all\+\_\+required\+\_\+libraries\#\+V\+S2012\+\_\+\+Build}
 370
 371 \subsubsection*{Compile Minetest}
 372
 373 \paragraph*{a) Using the vcpkg toolchain and C\+Make G\+UI}
 374
 375
 376 \begin{DoxyEnumerate}
 377 \item Start up the C\+Make G\+UI
 378 \item Select {\bfseries Browse Source...} and select D\+I\+R/minetest
 379 \item Select {\bfseries Browse Build...} and select D\+I\+R/minetest-\/build
 380 \item Select {\bfseries Configure}
 381 \item Choose the right visual Studio version and target platform. It has to match the version of the installed dependencies
 382 \item Choose {\bfseries Specify toolchain file for cross-\/compiling}
 383 \item Click {\bfseries Next}
 384 \item Select the vcpkg toolchain file e.\+g. {\ttfamily D\+:/vcpkg/scripts/buildsystems/vcpkg.cmake}
 385 \item Click Finish
 386 \item Wait until cmake have generated the cash file
 387 \item If there are any errors, solve them and hit {\bfseries Configure}
 388 \item Click {\bfseries Generate}
 389 \item Click {\bfseries Open Project}
 390 \item Compile Minetest inside Visual studio.
 391 \end{DoxyEnumerate}
 392
 393 \paragraph*{b) Using the vcpkg toolchain and the commandline}
 394
 395 Run the following script in Power\+Shell\+:
 396
 397
 398 \begin{DoxyCode}
 399 cmake . -G"Visual Studio 15 2017 Win64" -DCMAKE\_TOOLCHAIN\_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake
 400        -DCMAKE\_BUILD\_TYPE=Release -DENABLE\_GETTEXT=0 -DENABLE\_CURSES=0
 401 cmake --build . --config Release
 402 \end{DoxyCode}
 403  Make sure that the right compiler is selected and the path to the vcpkg toolchain is correct.
 404
 405 \paragraph*{c) Using your own compiled libraries}
 406
 407 {\bfseries This is outdated and not recommended}
 408
 409 Follow the instructions on \href{https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build}{\tt https\+://dev.\+minetest.\+net/\+Build\+\_\+\+Win32\+\_\+\+Minetest\+\_\+including\+\_\+all\+\_\+required\+\_\+libraries\#\+V\+S2012\+\_\+\+Build}
 410
 411 \subsubsection*{Windows Installer using WiX Toolset}
 412
 413 Requirements\+:
 414 \begin{DoxyItemize}
 415 \item \href{https://visualstudio.microsoft.com/}{\tt Visual Studio 2017}
 416 \item \href{https://wixtoolset.org/}{\tt WiX Toolset}
 417 \end{DoxyItemize}
 418
 419 In the Visual Studio 2017 Installer select {\bfseries Optional Features -\/$>$ WiX Toolset}.
 420
 421 Build the binaries as described above, but make sure you unselect {\ttfamily R\+U\+N\+\_\+\+I\+N\+\_\+\+P\+L\+A\+CE}.
 422
 423 Open the generated project file with Visual Studio. Right-\/click {\bfseries Package} and choose {\bfseries Generate}. It may take some minutes to generate the installer.
 424
 425 \subsection*{Docker }
 426
 427 We provide Minetest server Docker images using the Git\+Lab mirror registry.
 428
 429 Images are built on each commit and available using the following tag scheme\+:
 430
 431
 432 \begin{DoxyItemize}
 433 \item {\ttfamily registry.\+gitlab.\+com/minetest/minetest/server\+:latest} (latest build)
 434 \item {\ttfamily registry.\+gitlab.\+com/minetest/minetest/server\+:$<$branch/tag$>$} (current branch or current tag)
 435 \item {\ttfamily registry.\+gitlab.\+com/minetest/minetest/server\+:$<$commit-\/id$>$} (current commit id)
 436 \end{DoxyItemize}
 437
 438 If you want to test it on a Docker server you can easily run\+: \begin{DoxyVerb}sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
 439 \end{DoxyVerb}
 440
 441
 442 If you want to use it in a production environment you should use volumes bound to the Docker host to persist data and modify the configuration\+: \begin{DoxyVerb}sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
 443 \end{DoxyVerb}
 444
 445
 446 Data will be written to {\ttfamily /home/minetest/data} on the host, and configuration will be read from {\ttfamily /home/minetest/conf/minetest.conf}.
 447
 448 {\bfseries Note\+:} If you don\textquotesingle{}t understand the previous commands please read the official Docker documentation before use.
 449
 450 You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in \href{misc/kubernetes.yml}{\tt {\ttfamily misc/kubernetes.\+yml}}.
 451
 452 \subsection*{Version scheme }
 453
 454 We use {\ttfamily major.\+minor.\+patch} since 5.\+0.\+0-\/dev. Prior to that we used {\ttfamily 0.\+major.\+minor}.
 455
 456
 457 \begin{DoxyItemize}
 458 \item Major is incremented when the release contains breaking changes, all other numbers are set to 0.
 459 \item Minor is incremented when the release contains new non-\/breaking features, patch is set to 0.
 460 \item Patch is incremented when the release only contains bugfixes and very minor/trivial features considered necessary.
 461 \end{DoxyItemize}
 462
 463 Since 5.\+0.\+0-\/dev and 0.\+4.\+17-\/dev, the dev notation refers to the next release, i.\+e.\+: 5.\+0.\+0-\/dev is the development version leading to 5.\+0.\+0. Prior to that we used {\ttfamily previous\+\_\+version-\/dev}.