README.md

   1 Minetest
   2 ========
   3
   4 ![Build Status](https://github.com/minetest/minetest/workflows/build/badge.svg)
   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-2022 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: https://minetest.net/
  35 - Wiki: https://wiki.minetest.net/
  36 - Developer wiki: https://dev.minetest.net/
  37 - Forum: https://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 | P                             | 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                             | Aux1 (Move fast in fast mode. Games may add special features)  |
  72 | C                             | Cycle through camera modes                                     |
  73 | V                             | Cycle through minimap modes                                    |
  74 | Shift + V                     | Change minimap orientation                                     |
  75 | F1                            | Hide/show HUD                                                  |
  76 | F2                            | Hide/show chat                                                 |
  77 | F3                            | Disable/enable fog                                             |
  78 | F4                            | Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)  |
  79 | F5                            | Cycle through debug information screens                        |
  80 | F6                            | Cycle through profiler info screens                            |
  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` or `%MINETEST_USER_PATH%`
 102 * Linux installed:
 103     * `bin`   = `/usr/bin`
 104     * `share` = `/usr/share/minetest`
 105     * `user`  = `~/.minetest` or `$MINETEST_USER_PATH`
 106 * macOS:
 107     * `bin`   = `Contents/MacOS`
 108     * `share` = `Contents/Resources`
 109     * `user`  = `Contents/User` or `~/Library/Application Support/minetest` or `$MINETEST_USER_PATH`
 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 - This file is created by closing Minetest for 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        | 5.1+    | or Clang 3.5+ |
 136 | CMake      | 3.5+    |            |
 137 | IrrlichtMt | -       | Custom version of Irrlicht, see https://github.com/minetest/irrlicht |
 138 | Freetype   | 2.0+    |            |
 139 | SQLite3    | 3+      |            |
 140 | Zstd       | 1.0+    |            |
 141 | LuaJIT     | 2.0+    | Bundled Lua 5.1 is used if not present |
 142 | GMP        | 5.0.0+  | Bundled mini-GMP is used if not present |
 143 | JsonCPP    | 1.0.0+  | Bundled JsonCPP is used if not present |
 144
 145 For Debian/Ubuntu users:
 146
 147     sudo apt install g++ make libc6-dev cmake libpng-dev libjpeg-dev libxi-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libzstd-dev libluajit-5.1-dev
 148
 149 For Fedora users:
 150
 151     sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libcurl-devel openal-soft-devel libpng-devel libjpeg-devel libvorbis-devel libXi-devel libogg-devel freetype-devel mesa-libGL-devel zlib-devel jsoncpp-devel gmp-devel sqlite-devel luajit-devel leveldb-devel ncurses-devel spatialindex-devel libzstd-devel
 152
 153 For Arch users:
 154
 155     sudo pacman -S base-devel libcurl-gnutls cmake libxi libpng sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses zstd
 156
 157 For Alpine users:
 158
 159     sudo apk add build-base cmake libpng-dev jpeg-dev libxi-dev mesa-dev sqlite-dev libogg-dev libvorbis-dev openal-soft-dev curl-dev freetype-dev zlib-dev gmp-dev jsoncpp-dev luajit-dev zstd-dev
 160
 161 #### Download
 162
 163 You can install Git for easily keeping your copy up to date.
 164 If you don’t want Git, read below on how to get the source without Git.
 165 This is an example for installing Git on Debian/Ubuntu:
 166
 167     sudo apt install git
 168
 169 For Fedora users:
 170
 171     sudo dnf install git
 172
 173 For Arch users:
 174
 175         sudo pacman -S git
 176
 177 For Alpine users:
 178
 179         sudo apk add git
 180
 181 Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
 182
 183     git clone --depth 1 https://github.com/minetest/minetest.git
 184     cd minetest
 185
 186 Download Minetest Game (otherwise only the "Development Test" game is available) using Git:
 187
 188     git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 189
 190 Download IrrlichtMt to `lib/irrlichtmt`, it will be used to satisfy the IrrlichtMt dependency that way:
 191
 192     git clone --depth 1 https://github.com/minetest/irrlicht.git lib/irrlichtmt
 193
 194 Download source, without using Git:
 195
 196     wget https://github.com/minetest/minetest/archive/master.tar.gz
 197     tar xf master.tar.gz
 198     cd minetest-master
 199
 200 Download Minetest Game, without using Git:
 201
 202     cd games/
 203     wget https://github.com/minetest/minetest_game/archive/master.tar.gz
 204     tar xf master.tar.gz
 205     mv minetest_game-master minetest_game
 206     cd ..
 207
 208 Download IrrlichtMt, without using Git:
 209
 210     cd lib/
 211     wget https://github.com/minetest/irrlicht/archive/master.tar.gz
 212     tar xf master.tar.gz
 213     mv irrlicht-master irrlichtmt
 214     cd ..
 215
 216 #### Build
 217
 218 Build a version that runs directly from the source directory:
 219
 220     cmake . -DRUN_IN_PLACE=TRUE
 221     make -j$(nproc)
 222
 223 Run it:
 224
 225     ./bin/minetest
 226
 227 - Use `cmake . -LH` to see all CMake options and their current state.
 228 - If you want to install it system-wide (or are making a distribution package),
 229   you will want to use `-DRUN_IN_PLACE=FALSE`.
 230 - You can build a bare server by specifying `-DBUILD_SERVER=TRUE`.
 231 - You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`.
 232 - You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`.
 233   - Debug build is slower, but gives much more useful output in a debugger.
 234 - If you build a bare server you don't need to compile IrrlichtMt, just the headers suffice.
 235   - In that case use `-DIRRLICHT_INCLUDE_DIR=/some/where/irrlichtmt/include`.
 236
 237 - Minetest will use the IrrlichtMt package that is found first, given by the following order:
 238   1. Specified `IRRLICHTMT_BUILD_DIR` CMake variable
 239   2. `${PROJECT_SOURCE_DIR}/lib/irrlichtmt` (if existent)
 240   3. Installation of IrrlichtMt in the system-specific library paths
 241   4. For server builds with disabled `BUILD_CLIENT` variable, the headers from `IRRLICHT_INCLUDE_DIR` will be used.
 242   - NOTE: Changing the IrrlichtMt build directory (includes system installs) requires regenerating the CMake cache (`rm CMakeCache.txt`)
 243
 244 ### CMake options
 245
 246 General options and their default values:
 247
 248     BUILD_CLIENT=TRUE          - Build Minetest client
 249     BUILD_SERVER=FALSE         - Build Minetest server
 250     BUILD_UNITTESTS=TRUE       - Build unittest sources
 251     BUILD_BENCHMARKS=FALSE     - Build benchmark sources
 252     CMAKE_BUILD_TYPE=Release   - Type of build (Release vs. Debug)
 253         Release                - Release build
 254         Debug                  - Debug build
 255         SemiDebug              - Partially optimized debug build
 256         RelWithDebInfo         - Release build with debug information
 257         MinSizeRel             - Release build with -Os passed to compiler to make executable as small as possible
 258     ENABLE_CURL=ON             - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 259     ENABLE_CURSES=ON           - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
 260     ENABLE_GETTEXT=ON          - Build with Gettext; Allows using translations
 261     ENABLE_GLES=OFF            - Enable extra support code for OpenGL ES (requires support by IrrlichtMt)
 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_PROMETHEUS=OFF      - Build with Prometheus metrics exporter (listens on tcp/30000 by default)
 269     ENABLE_SYSTEM_GMP=ON       - Use GMP from system (much faster than bundled mini-gmp)
 270     ENABLE_SYSTEM_JSONCPP=ON   - Use JsonCPP from system
 271     RUN_IN_PLACE=FALSE         - Create a portable install (worlds, settings etc. in current directory)
 272     ENABLE_UPDATE_CHECKER=TRUE - Whether to enable update checks by default
 273     INSTALL_DEVTEST=FALSE      - Whether the Development Test game should be installed alongside Minetest
 274     USE_GPROF=FALSE            - Enable profiling using GProf
 275     VERSION_EXTRA=             - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 276     ENABLE_TOUCH=FALSE         - Enable Touchscreen support (requires support by IrrlichtMt)
 277
 278 Library specific options:
 279
 280     CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 281     CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 282     CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 283     EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 284     EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
 285     EXTRA_DLL                       - Only on Windows; optional paths to additional DLLs that should be packaged
 286     FREETYPE_INCLUDE_DIR_freetype2  - Directory that contains files such as ftimage.h
 287     FREETYPE_INCLUDE_DIR_ft2build   - Directory that contains ft2build.h
 288     FREETYPE_LIBRARY                - Path to libfreetype.a/libfreetype.so/freetype.lib
 289     FREETYPE_DLL                    - Only on Windows; path to libfreetype-6.dll
 290     GETTEXT_DLL                     - Only when building with gettext on Windows; paths to libintl + libiconv DLLs
 291     GETTEXT_INCLUDE_DIR             - Only when building with gettext; directory that contains libintl.h
 292     GETTEXT_LIBRARY                 - Optional/platform-dependent with gettext; path to libintl.so/libintl.dll.a
 293     GETTEXT_MSGFMT                  - Only when building with gettext; path to msgfmt/msgfmt.exe
 294     ICONV_LIBRARY                   - Optional/platform-dependent; path to libiconv.so/libiconv.dylib
 295     IRRLICHT_DLL                    - Only on Windows; path to IrrlichtMt.dll
 296     IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h (usable for server build only)
 297     LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 298     LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
 299     LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 300     PostgreSQL_INCLUDE_DIR          - Only when building with PostgreSQL; directory that contains libpq-fe.h
 301     PostgreSQL_LIBRARY              - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib
 302     REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
 303     REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
 304     SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
 305     SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex.so/spatialindex-32.lib
 306     LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 307     LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 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     SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
 315     SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
 316     VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 317     VORBIS_DLL                      - Only if building with sound on Windows; paths to vorbis DLLs
 318     VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 319     VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 320     ZLIB_DLL                        - Only on Windows; path to zlib1.dll
 321     ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
 322     ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlib.lib
 323     ZSTD_DLL                        - Only on Windows; path to libzstd.dll
 324     ZSTD_INCLUDE_DIR                - Directory that contains zstd.h
 325     ZSTD_LIBRARY                    - Path to libzstd.a/libzstd.so/ztd.lib
 326
 327 ### Compiling on Windows using MSVC
 328
 329 ### Requirements
 330
 331 - [Visual Studio 2015 or newer](https://visualstudio.microsoft.com)
 332 - [CMake](https://cmake.org/download/)
 333 - [vcpkg](https://github.com/Microsoft/vcpkg)
 334 - [Git](https://git-scm.com/downloads)
 335
 336 ### Compiling and installing the dependencies
 337
 338 It is highly recommended to use vcpkg as package manager.
 339
 340 After you successfully built vcpkg you can easily install the required libraries:
 341 ```powershell
 342 vcpkg install zlib zstd curl[winssl] openal-soft libvorbis libogg libjpeg-turbo sqlite3 freetype luajit gmp jsoncpp opengl-registry --triplet x64-windows
 343 ```
 344
 345 - **Don't forget about IrrlichtMt.** The easiest way is to clone it to `lib/irrlichtmt` as described in the Linux section.
 346 - `curl` is optional, but required to read the serverlist, `curl[winssl]` is required to use the content store.
 347 - `openal-soft`, `libvorbis` and `libogg` are optional, but required to use sound.
 348 - `luajit` is optional, it replaces the integrated Lua interpreter with a faster just-in-time interpreter.
 349 - `gmp` and `jsoncpp` are optional, otherwise the bundled versions will be compiled
 350
 351 There are other optional libraries, but they are not tested if they can build and link correctly.
 352
 353 Use `--triplet` to specify the target triplet, e.g. `x64-windows` or `x86-windows`.
 354
 355 ### Compile Minetest
 356
 357 #### a) Using the vcpkg toolchain and CMake GUI
 358 1. Start up the CMake GUI
 359 2. Select **Browse Source...** and select DIR/minetest
 360 3. Select **Browse Build...** and select DIR/minetest-build
 361 4. Select **Configure**
 362 5. Choose the right visual Studio version and target platform. It has to match the version of the installed dependencies
 363 6. Choose **Specify toolchain file for cross-compiling**
 364 7. Click **Next**
 365 8. Select the vcpkg toolchain file e.g. `D:/vcpkg/scripts/buildsystems/vcpkg.cmake`
 366 9. Click Finish
 367 10. Wait until cmake have generated the cash file
 368 11. If there are any errors, solve them and hit **Configure**
 369 12. Click **Generate**
 370 13. Click **Open Project**
 371 14. Compile Minetest inside Visual studio.
 372
 373 #### b) Using the vcpkg toolchain and the commandline
 374
 375 Run the following script in PowerShell:
 376
 377 ```powershell
 378 cmake . -G"Visual Studio 15 2017 Win64" -DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_GETTEXT=OFF -DENABLE_CURSES=OFF
 379 cmake --build . --config Release
 380 ```
 381 Make sure that the right compiler is selected and the path to the vcpkg toolchain is correct.
 382
 383 ### Windows Installer using WiX Toolset
 384
 385 Requirements:
 386 * [Visual Studio 2017](https://visualstudio.microsoft.com/)
 387 * [WiX Toolset](https://wixtoolset.org/)
 388
 389 In the Visual Studio 2017 Installer select **Optional Features -> WiX Toolset**.
 390
 391 Build the binaries as described above, but make sure you unselect `RUN_IN_PLACE`.
 392
 393 Open the generated project file with Visual Studio. Right-click **Package** and choose **Generate**.
 394 It may take some minutes to generate the installer.
 395
 396 ### Compiling on MacOS
 397
 398 #### Requirements
 399 - [Homebrew](https://brew.sh/)
 400 - [Git](https://git-scm.com/downloads)
 401
 402 Install dependencies with homebrew:
 403
 404 ```
 405 brew install cmake freetype gettext gmp hiredis jpeg jsoncpp leveldb libogg libpng libvorbis luajit zstd
 406 ```
 407
 408 #### Download
 409
 410 Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
 411
 412 ```bash
 413 git clone --depth 1 https://github.com/minetest/minetest.git
 414 cd minetest
 415 ```
 416
 417 Download Minetest Game (otherwise only the "Development Test" game is available) using Git:
 418
 419 ```
 420 git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 421 ```
 422
 423 Download Minetest's fork of Irrlicht:
 424
 425 ```
 426 git clone --depth 1 https://github.com/minetest/irrlicht.git lib/irrlichtmt
 427 ```
 428
 429 #### Build
 430
 431 ```bash
 432 mkdir build
 433 cd build
 434
 435 cmake .. \
 436     -DCMAKE_OSX_DEPLOYMENT_TARGET=10.14 \
 437     -DCMAKE_FIND_FRAMEWORK=LAST \
 438     -DCMAKE_INSTALL_PREFIX=../build/macos/ \
 439     -DRUN_IN_PLACE=FALSE -DENABLE_GETTEXT=TRUE
 440
 441 make -j$(sysctl -n hw.logicalcpu)
 442 make install
 443 ```
 444
 445 #### Run
 446
 447 ```
 448 open ./build/macos/minetest.app
 449 ```
 450
 451 Docker
 452 ------
 453 We provide Minetest server Docker images using the GitLab mirror registry.
 454
 455 Images are built on each commit and available using the following tag scheme:
 456
 457 * `registry.gitlab.com/minetest/minetest/server:latest` (latest build)
 458 * `registry.gitlab.com/minetest/minetest/server:<branch/tag>` (current branch or current tag)
 459 * `registry.gitlab.com/minetest/minetest/server:<commit-id>` (current commit id)
 460
 461 If you want to test it on a Docker server you can easily run:
 462
 463         sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
 464
 465 If you want to use it in a production environment you should use volumes bound to the Docker host
 466 to persist data and modify the configuration:
 467
 468         sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
 469
 470 Data will be written to `/home/minetest/data` on the host, and configuration will be read from `/home/minetest/conf/minetest.conf`.
 471
 472 **Note:** If you don't understand the previous commands please read the official Docker documentation before use.
 473
 474 You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in [`misc/kubernetes.yml`](misc/kubernetes.yml).
 475
 476
 477 Version scheme
 478 --------------
 479 We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
 480
 481 - Major is incremented when the release contains breaking changes, all other
 482 numbers are set to 0.
 483 - Minor is incremented when the release contains new non-breaking features,
 484 patch is set to 0.
 485 - Patch is incremented when the release only contains bugfixes and very
 486 minor/trivial features considered necessary.
 487
 488 Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
 489 i.e.: 5.0.0-dev is the development version leading to 5.0.0.
 490 Prior to that we used `previous_version-dev`.