README.md

   1 Minetest
   2 ========
   3
   4 [![Build Status](https://travis-ci.org/minetest/minetest.svg?branch=master)](https://travis-ci.org/minetest/minetest)
   5 [![Translation status](https://hosted.weblate.org/widgets/minetest/-/svg-badge.svg)](https://hosted.weblate.org/engage/minetest/?utm_source=widget)
   6 [![License](https://img.shields.io/badge/license-LGPLv2.1%2B-blue.svg)](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
   7
   8 Minetest is a free open-source voxel game engine with easy modding and game creation.
   9
  10 Copyright (C) 2010-2018 Perttu Ahola <celeron55@gmail.com>
  11 and contributors (see source file comments and the version control log)
  12
  13 In case you downloaded the source code:
  14 ---------------------------------------
  15 If you downloaded the Minetest Engine source code in which this file is
  16 contained, you probably want to download the [Minetest Game](https://github.com/minetest/minetest_game/)
  17 project too. See its README.txt for more information.
  18
  19 Table of Contents
  20 ------------------
  21
  22 1. [Further Documentation](#further-documentation)
  23 2. [Default Controls](#default-controls)
  24 3. [Paths](#paths)
  25 4. [Configuration File](#configuration-file)
  26 5. [Command-line Options](#command-line-options)
  27 6. [Compiling](#compiling)
  28 7. [Docker](#docker)
  29 8. [Version Scheme](#version-scheme)
  30
  31
  32 Further documentation
  33 ----------------------
  34 - Website: http://minetest.net/
  35 - Wiki: http://wiki.minetest.net/
  36 - Developer wiki: http://dev.minetest.net/
  37 - Forum: http://forum.minetest.net/
  38 - GitHub: https://github.com/minetest/minetest/
  39 - [doc/](doc/) directory of source distribution
  40
  41 Default controls
  42 ----------------
  43 All controls are re-bindable using settings.
  44 Some can be changed in the key config dialog in the settings tab.
  45
  46 | Button                        | Action                                                         |
  47 |-------------------------------|----------------------------------------------------------------|
  48 | Move mouse                    | Look around                                                    |
  49 | W, A, S, D                    | Move                                                           |
  50 | Space                         | Jump/move up                                                   |
  51 | Shift                         | Sneak/move down                                                |
  52 | Q                             | Drop itemstack                                                 |
  53 | Shift + Q                     | Drop single item                                               |
  54 | Left mouse button             | Dig/punch/take item                                            |
  55 | Right mouse button            | Place/use                                                      |
  56 | Shift + right mouse button    | Build (without using)                                          |
  57 | I                             | Inventory menu                                                 |
  58 | Mouse wheel                   | Select item                                                    |
  59 | 0-9                           | Select item                                                    |
  60 | Z                             | Zoom (needs zoom privilege)                                    |
  61 | T                             | Chat                                                           |
  62 | /                             | Command                                                        |
  63 | Esc                           | Pause menu/abort/exit (pauses only singleplayer game)          |
  64 | R                             | Enable/disable full range view                                 |
  65 | +                             | Increase view range                                            |
  66 | -                             | Decrease view range                                            |
  67 | K                             | Enable/disable fly mode (needs fly privilege)                  |
  68 | L                             | Enable/disable pitch move mode                                 |
  69 | J                             | Enable/disable fast mode (needs fast privilege)                |
  70 | H                             | Enable/disable noclip mode (needs noclip privilege)            |
  71 | E                             | Move fast in fast mode                                         |
  72 | F1                            | Hide/show HUD                                                  |
  73 | F2                            | Hide/show chat                                                 |
  74 | F3                            | Disable/enable fog                                             |
  75 | F4                            | Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)  |
  76 | F5                            | Cycle through debug information screens                        |
  77 | F6                            | Cycle through profiler info screens                            |
  78 | F7                            | Cycle through camera modes                                     |
  79 | F9                            | Cycle through minimap modes                                    |
  80 | Shift + F9                    | Change minimap orientation                                     |
  81 | F10                           | Show/hide console                                              |
  82 | F12                           | Take screenshot                                                |
  83
  84 Paths
  85 -----
  86 Locations:
  87
  88 * `bin`   - Compiled binaries
  89 * `share` - Distributed read-only data
  90 * `user`  - User-created modifiable data
  91
  92 Where each location is on each platform:
  93
  94 * Windows .zip / RUN_IN_PLACE source:
  95     * bin   = `bin`
  96     * share = `.`
  97     * user  = `.`
  98 * Windows installed:
  99     * $bin   = `C:\Program Files\Minetest\bin (Depends on the install location)`
 100     * $share = `C:\Program Files\Minetest (Depends on the install location)`
 101     * $user  = `%Appdata%\Minetest`
 102 * Linux installed:
 103     * `bin`   = `/usr/bin`
 104     * `share` = `/usr/share/minetest`
 105     * `user`  = `~/.minetest`
 106 * macOS:
 107     * `bin`   = `Contents/MacOS`
 108     * `share` = `Contents/Resources`
 109     * `user`  = `Contents/User OR ~/Library/Application Support/minetest`
 110
 111 Worlds can be found as separate folders in: `user/worlds/`
 112
 113 Configuration file:
 114 -------------------
 115 - Default location:
 116     `user/minetest.conf`
 117 - It is created by Minetest when it is ran the first time.
 118 - A specific file can be specified on the command line:
 119     `--config <path-to-file>`
 120 - A run-in-place build will look for the configuration file in
 121     `location_of_exe/../minetest.conf` and also `location_of_exe/../../minetest.conf`
 122
 123 Command-line options:
 124 ---------------------
 125 - Use `--help`
 126
 127 Compiling
 128 ---------
 129 ### Compiling on GNU/Linux
 130
 131 #### Dependencies
 132
 133 | Dependency | Version | Commentary |
 134 |------------|---------|------------|
 135 | GCC        | 4.9+    | Can be replaced with Clang 3.4+ |
 136 | CMake      | 2.6+    |            |
 137 | Irrlicht   | 1.7.3+  |            |
 138 | SQLite3    | 3.0+    |            |
 139 | LuaJIT     | 2.0+    | Bundled Lua 5.1 is used if not present |
 140 | GMP        | 5.0.0+  | Bundled mini-GMP is used if not present |
 141 | JsonCPP    | 1.0.0+  | Bundled JsonCPP is used if not present |
 142
 143 For Debian/Ubuntu:
 144
 145     sudo apt install build-essential 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
 146
 147 For Fedora users:
 148
 149     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
 150
 151 #### Download
 152
 153 You can install Git for easily keeping your copy up to date.
 154 If you don’t want Git, read below on how to get the source without Git.
 155 This is an example for installing Git on Debian/Ubuntu:
 156
 157     sudo apt install git
 158
 159 For Fedora users:
 160
 161     sudo dnf install git
 162
 163 Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
 164
 165     git clone --depth 1 https://github.com/minetest/minetest.git
 166     cd minetest
 167
 168 Download minetest_game (otherwise only the "Minimal development test" game is available) using Git:
 169
 170     git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 171
 172 Download source, without using Git:
 173
 174     wget https://github.com/minetest/minetest/archive/master.tar.gz
 175     tar xf master.tar.gz
 176     cd minetest-master
 177
 178 Download minetest_game, without using Git:
 179
 180     cd games/
 181     wget https://github.com/minetest/minetest_game/archive/master.tar.gz
 182     tar xf master.tar.gz
 183     mv minetest_game-master minetest_game
 184     cd ..
 185
 186 #### Build
 187
 188 Build a version that runs directly from the source directory:
 189
 190     cmake . -DRUN_IN_PLACE=TRUE
 191     make -j <number of processors>
 192
 193 Run it:
 194
 195     ./bin/minetest
 196
 197 - Use `cmake . -LH` to see all CMake options and their current state
 198 - If you want to install it system-wide (or are making a distribution package),
 199   you will want to use `-DRUN_IN_PLACE=FALSE`
 200 - You can build a bare server by specifying `-DBUILD_SERVER=TRUE`
 201 - You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`
 202 - You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`
 203   - Debug build is slower, but gives much more useful output in a debugger
 204 - If you build a bare server, you don't need to have Irrlicht installed.
 205   - In that case use `-DIRRLICHT_SOURCE_DIR=/the/irrlicht/source`
 206
 207 ### CMake options
 208
 209 General options and their default values:
 210
 211     BUILD_CLIENT=TRUE          - Build Minetest client
 212     BUILD_SERVER=FALSE         - Build Minetest server
 213     CMAKE_BUILD_TYPE=Release   - Type of build (Release vs. Debug)
 214         Release                - Release build
 215         Debug                  - Debug build
 216         SemiDebug              - Partially optimized debug build
 217         RelWithDebInfo         - Release build with debug information
 218         MinSizeRel             - Release build with -Os passed to compiler to make executable as small as possible
 219     ENABLE_CURL=ON             - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 220     ENABLE_CURSES=ON           - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
 221     ENABLE_FREETYPE=ON         - Build with FreeType2; Allows using TTF fonts
 222     ENABLE_GETTEXT=ON          - Build with Gettext; Allows using translations
 223     ENABLE_GLES=OFF            - Search for Open GLES headers & libraries and use them
 224     ENABLE_LEVELDB=ON          - Build with LevelDB; Enables use of LevelDB map backend
 225     ENABLE_POSTGRESQL=ON       - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
 226     ENABLE_REDIS=ON            - Build with libhiredis; Enables use of Redis map backend
 227     ENABLE_SPATIAL=ON          - Build with LibSpatial; Speeds up AreaStores
 228     ENABLE_SOUND=ON            - Build with OpenAL, libogg & libvorbis; in-game sounds
 229     ENABLE_LUAJIT=ON           - Build with LuaJIT (much faster than non-JIT Lua)
 230     ENABLE_SYSTEM_GMP=ON       - Use GMP from system (much faster than bundled mini-gmp)
 231     ENABLE_SYSTEM_JSONCPP=OFF  - Use JsonCPP from system
 232     OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference
 233     RUN_IN_PLACE=FALSE         - Create a portable install (worlds, settings etc. in current directory)
 234     USE_GPROF=FALSE            - Enable profiling using GProf
 235     VERSION_EXTRA=             - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 236
 237 Library specific options:
 238
 239     BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
 240     BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
 241     CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 242     CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 243     CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 244     EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 245     EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
 246     FREETYPE_INCLUDE_DIR_freetype2  - Only if building with FreeType 2; directory that contains an freetype directory with files such as ftimage.h in it
 247     FREETYPE_INCLUDE_DIR_ft2build   - Only if building with FreeType 2; directory that contains ft2build.h
 248     FREETYPE_LIBRARY                - Only if building with FreeType 2; path to libfreetype.a/libfreetype.so/freetype.lib
 249     FREETYPE_DLL                    - Only if building with FreeType 2 on Windows; path to libfreetype.dll
 250     GETTEXT_DLL                     - Only when building with gettext on Windows; path to libintl3.dll
 251     GETTEXT_ICONV_DLL               - Only when building with gettext on Windows; path to libiconv2.dll
 252     GETTEXT_INCLUDE_DIR             - Only when building with gettext; directory that contains iconv.h
 253     GETTEXT_LIBRARY                 - Only when building with gettext on Windows; path to libintl.dll.a
 254     GETTEXT_MSGFMT                  - Only when building with gettext; path to msgfmt/msgfmt.exe
 255     IRRLICHT_DLL                    - Only on Windows; path to Irrlicht.dll
 256     IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h
 257     IRRLICHT_LIBRARY                - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
 258     LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 259     LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
 260     LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 261     PostgreSQL_INCLUDE_DIR          - Only when building with PostgreSQL; directory that contains libpq-fe.h
 262     PostgreSQL_LIBRARY              - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib
 263     REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
 264     REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
 265     SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
 266     SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
 267     LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 268     LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 269     MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
 270     OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
 271     OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
 272     OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
 273     OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
 274     OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
 275     OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
 276     OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
 277     OPENGLES2_LIBRARY               - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
 278     SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
 279     SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
 280     VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
 281     VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 282     VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
 283     VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 284     VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 285     XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
 286     ZLIB_DLL                        - Only on Windows; path to zlib1.dll
 287     ZLIBWAPI_DLL                    - Only on Windows; path to zlibwapi.dll
 288     ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
 289     ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlibwapi.lib
 290
 291 ### Compiling on Windows
 292
 293 * This section is outdated. In addition to what is described here:
 294   * In addition to minetest, you need to download [minetest_game](https://github.com/minetest/minetest_game).
 295   * If you wish to have sound support, you need libogg, libvorbis and libopenal
 296
 297 * You need:
 298         * CMake:
 299                 http://www.cmake.org/cmake/resources/software.html
 300         * A compiler
 301                 * MinGW: http://www.mingw.org/
 302                 * or Visual Studio: http://msdn.microsoft.com/en-us/vstudio/default
 303         * Irrlicht SDK 1.7:
 304                 http://irrlicht.sourceforge.net/downloads.html
 305         * Zlib headers (zlib125.zip)
 306                 http://www.winimage.com/zLibDll/index.html
 307         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
 308                 http://www.winimage.com/zLibDll/index.html
 309         * SQLite3 headers and library
 310                 https://www.sqlite.org/download.html
 311         * Optional: gettext library and tools:
 312                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
 313                 * This is used for other UI languages. Feel free to leave it out.
 314         * And, of course, Minetest:
 315                 http://minetest.net/download
 316 * Steps:
 317         * Select a directory called DIR hereafter in which you will operate.
 318         * Make sure you have CMake and a compiler installed.
 319         * Download all the other stuff to DIR and extract them into there.
 320           ("extract here", not "extract to packagename/")
 321             * NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 322             * NOTE: You need to extract sqlite3.h & sqlite3ext.h from the SQLite 3
 323               source and sqlite3.dll & sqlite3.def from the SQLite 3 precompiled
 324               binaries into "sqlite3" directory, and generate sqlite3.lib using
 325               command "LIB /DEF:sqlite3.def /OUT:sqlite3.lib"
 326         * All those packages contain a nice base directory in them, which
 327           should end up being the direct subdirectories of DIR.
 328         * You will end up with a directory structure like this (+=dir, -=file):
 329         -----------------
 330         + DIR
 331                 * zlib-1.2.5.tar.gz
 332                 * zlib125dll.zip
 333                 * irrlicht-1.8.3.zip
 334                 * sqlite-amalgamation-3130000.zip (SQLite3 headers)
 335                 * sqlite-dll-win32-x86-3130000.zip (SQLite3 library for 32bit system)
 336                 * 110214175330.zip (or whatever, this is the minetest source)
 337                 + zlib-1.2.5
 338                         * zlib.h
 339                         + win32
 340                         ...
 341                 + zlib125dll
 342                         * readme.txt
 343                         + dll32
 344                         ...
 345                 + irrlicht-1.8.3
 346                         + lib
 347                         + include
 348                         ...
 349                 + sqlite3
 350                         sqlite3.h
 351                         sqlite3ext.h
 352                         sqlite3.lib
 353                         sqlite3.dll
 354                 + gettext (optional)
 355                         +bin
 356                         +include
 357                         +lib
 358                 + minetest
 359                         + src
 360                         + doc
 361                         * CMakeLists.txt
 362                         ...
 363         -----------------
 364         * Start up the CMake GUI
 365         * Select "Browse Source..." and select DIR/minetest
 366         * Now, if using MSVC:
 367                 * Select "Browse Build..." and select DIR/minetest-build
 368         * Else if using MinGW:
 369                 * Select "Browse Build..." and select DIR/minetest
 370         * Select "Configure"
 371         * Select your compiler
 372         * It will warn about missing stuff, ignore that at this point. (later don't)
 373         * Make sure the configuration is as follows
 374           (note that the versions may differ for you):
 375
 376                 BUILD_CLIENT             [X]
 377                 BUILD_SERVER             [ ]
 378                 CMAKE_BUILD_TYPE         Release
 379                 CMAKE_INSTALL_PREFIX     DIR/minetest-install
 380                 IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.8.3
 381                 RUN_IN_PLACE             [X]
 382                 WARN_ALL                 [ ]
 383                 ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 384                 ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 385                 ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 386                 GETTEXT_BIN_DIR          DIR/gettext/bin
 387                 GETTEXT_INCLUDE_DIR      DIR/gettext/include
 388                 GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 389                 GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 390
 391         * If CMake complains it couldn't find SQLITE3, choose "Advanced" box on the
 392           right top corner, then specify the location of SQLITE3_INCLUDE_DIR and
 393           SQLITE3_LIBRARY manually.
 394         * If you want to build 64-bit minetest, you will need to build 64-bit version
 395           of irrlicht engine manually, as only 32-bit pre-built library is provided.
 396         * Hit "Configure"
 397         * Hit "Configure" once again 8)
 398         * If something is still coloured red, you have a problem.
 399         * Hit "Generate"
 400         If using MSVC:
 401                 * Open the generated minetest.sln
 402                 * The project defaults to the "Debug" configuration. Make very sure to
 403                   select "Release", unless you want to debug some stuff (it's slower
 404                   and might not even work at all)
 405                 * Build the ALL_BUILD project
 406                 * Build the INSTALL project
 407                 * You should now have a working game with the executable in
 408                         DIR/minetest-install/bin/minetest.exe
 409                 * Additionally you may create a zip package by building the PACKAGE
 410                   project.
 411         If using MinGW:
 412                 * Using the command line, browse to the build directory and run 'make'
 413                   (or mingw32-make or whatever it happens to be)
 414                 * You may need to copy some of the downloaded DLLs into bin/, see what
 415                   running the produced executable tells you it doesn't have.
 416                 * You should now have a working game with the executable in
 417                         DIR/minetest/bin/minetest.exe
 418
 419 ### Bat script to build Windows releases of Minetest
 420
 421 This is how we build Windows releases.
 422
 423     set sourcedir=%CD%
 424     set installpath="C:\tmp\minetest_install"
 425     set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 426
 427     set builddir=%sourcedir%\bvc10
 428     mkdir %builddir%
 429     pushd %builddir%
 430     cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
 431     if %errorlevel% neq 0 goto fail
 432     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 433     if %errorlevel% neq 0 goto fail
 434     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 435     if %errorlevel% neq 0 goto fail
 436     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 437     if %errorlevel% neq 0 goto fail
 438     popd
 439     echo Finished.
 440     exit /b 0
 441
 442     :fail
 443     popd
 444     echo Failed.
 445     exit /b 1
 446
 447 ### Windows Installer using WIX Toolset
 448
 449 Requirements:
 450 * Visual Studio 2017
 451 * Wix Toolset
 452
 453 In Visual Studio 2017 Installer select "Optional Features" -> "Wix Toolset"
 454
 455 Build the binaries like described above, but make sure you unselect "RUN_IN_PLACE".
 456
 457 Open the generated Project file with VS. Right click "PACKAGE" and choose "Generate".
 458 It may take some minutes to generate the installer.
 459
 460
 461 Docker
 462 ------
 463 We provide Minetest server docker images using the Gitlab mirror registry.
 464
 465 Images are built on each commit and available using the following tag scheme:
 466
 467 * `registry.gitlab.com/minetest/minetest/server:latest` (latest build)
 468 * `registry.gitlab.com/minetest/minetest/server:<branch/tag>` (current branch or current tag)
 469 * `registry.gitlab.com/minetest/minetest/server:<commit-id>` (current commit id)
 470
 471 If you want to test it on a docker server, you can easily run:
 472
 473         sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
 474
 475 If you want to use it in a production environment you should use volumes bound to the docker host
 476 to persist data and modify the configuration:
 477
 478         sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
 479
 480 Data will be written to `/home/minetest/data` on the host, and configuration will be read from `/home/minetest/conf/minetest.conf`.
 481
 482 Note: If you don't understand the previous commands, please read the official Docker documentation before use.
 483
 484 You can also host your minetest server inside a Kubernetes cluster. See our example implementation in `misc/kubernetes.yml`.
 485
 486
 487 Version scheme
 488 --------------
 489 We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
 490
 491 - Major is incremented when the release contains breaking changes, all other
 492 numbers are set to 0.
 493 - Minor is incremented when the release contains new non-breaking features,
 494 patch is set to 0.
 495 - Patch is incremented when the release only contains bugfixes and very
 496 minor/trivial features considered necessary.
 497
 498 Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
 499 i.e.: 5.0.0-dev is the development version leading to 5.0.0.
 500 Prior to that we used `previous_version-dev`.