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-2020 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`
 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 - 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        | 4.9+    | Can be replaced with Clang 3.4+ |
 136 | CMake      | 3.5+    |            |
 137 | IrrlichtMt | -       | Custom version of Irrlicht, see https://github.com/minetest/irrlicht |
 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 users:
 144
 145     sudo apt install g++ make libc6-dev cmake 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 gmp-devel sqlite-devel luajit-devel leveldb-devel ncurses-devel spatialindex-devel
 150
 151 For Arch users:
 152
 153     sudo pacman -S base-devel libcurl-gnutls cmake libxxf86vm libpng sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses
 154
 155 For Alpine users:
 156
 157     sudo apk add build-base cmake 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
 158
 159 #### Download
 160
 161 You can install Git for easily keeping your copy up to date.
 162 If you don’t want Git, read below on how to get the source without Git.
 163 This is an example for installing Git on Debian/Ubuntu:
 164
 165     sudo apt install git
 166
 167 For Fedora users:
 168
 169     sudo dnf install git
 170
 171 Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
 172
 173     git clone --depth 1 https://github.com/minetest/minetest.git
 174     cd minetest
 175
 176 Download minetest_game (otherwise only the "Development Test" game is available) using Git:
 177
 178     git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 179
 180 Download IrrlichtMt to `lib/irrlichtmt`, it will be used to satisfy the IrrlichtMt dependency that way:
 181
 182     git clone --depth 1 https://github.com/minetest/irrlicht.git lib/irrlichtmt
 183
 184 Download source, without using Git:
 185
 186     wget https://github.com/minetest/minetest/archive/master.tar.gz
 187     tar xf master.tar.gz
 188     cd minetest-master
 189
 190 Download minetest_game, without using Git:
 191
 192     cd games/
 193     wget https://github.com/minetest/minetest_game/archive/master.tar.gz
 194     tar xf master.tar.gz
 195     mv minetest_game-master minetest_game
 196     cd ..
 197
 198 Download IrrlichtMt, without using Git:
 199
 200     cd lib/
 201     wget https://github.com/minetest/irrlicht/archive/master.tar.gz
 202     tar xf master.tar.gz
 203     mv irrlicht-master irrlichtmt
 204     cd ..
 205
 206 #### Build
 207
 208 Build a version that runs directly from the source directory:
 209
 210     cmake . -DRUN_IN_PLACE=TRUE
 211     make -j$(nproc)
 212
 213 Run it:
 214
 215     ./bin/minetest
 216
 217 - Use `cmake . -LH` to see all CMake options and their current state.
 218 - If you want to install it system-wide (or are making a distribution package),
 219   you will want to use `-DRUN_IN_PLACE=FALSE`.
 220 - You can build a bare server by specifying `-DBUILD_SERVER=TRUE`.
 221 - You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`.
 222 - You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`.
 223   - Debug build is slower, but gives much more useful output in a debugger.
 224 - If you build a bare server you don't need to have the Irrlicht or IrrlichtMt library installed.
 225   - In that case use `-DIRRLICHT_INCLUDE_DIR=/some/where/irrlicht/include`.
 226 - IrrlichtMt can also be installed somewhere that is not a standard install path.
 227   - In that case use `-DCMAKE_PREFIX_PATH=/path/to/install_prefix`
 228   - The path must be set so that `$(CMAKE_PREFIX_PATH)/lib/cmake/IrrlichtMt` exists.
 229
 230 ### CMake options
 231
 232 General options and their default values:
 233
 234     BUILD_CLIENT=TRUE          - Build Minetest client
 235     BUILD_SERVER=FALSE         - Build Minetest server
 236     BUILD_UNITTESTS=TRUE       - Build unittest sources
 237     CMAKE_BUILD_TYPE=Release   - Type of build (Release vs. Debug)
 238         Release                - Release build
 239         Debug                  - Debug build
 240         SemiDebug              - Partially optimized debug build
 241         RelWithDebInfo         - Release build with debug information
 242         MinSizeRel             - Release build with -Os passed to compiler to make executable as small as possible
 243     ENABLE_CURL=ON             - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 244     ENABLE_CURSES=ON           - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
 245     ENABLE_FREETYPE=ON         - Build with FreeType2; Allows using TTF fonts
 246     ENABLE_GETTEXT=ON          - Build with Gettext; Allows using translations
 247     ENABLE_GLES=OFF            - Build for OpenGL ES instead of OpenGL (requires support by IrrlichtMt)
 248     ENABLE_LEVELDB=ON          - Build with LevelDB; Enables use of LevelDB map backend
 249     ENABLE_POSTGRESQL=ON       - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
 250     ENABLE_REDIS=ON            - Build with libhiredis; Enables use of Redis map backend
 251     ENABLE_SPATIAL=ON          - Build with LibSpatial; Speeds up AreaStores
 252     ENABLE_SOUND=ON            - Build with OpenAL, libogg & libvorbis; in-game sounds
 253     ENABLE_LUAJIT=ON           - Build with LuaJIT (much faster than non-JIT Lua)
 254     ENABLE_PROMETHEUS=OFF      - Build with Prometheus metrics exporter (listens on tcp/30000 by default)
 255     ENABLE_SYSTEM_GMP=ON       - Use GMP from system (much faster than bundled mini-gmp)
 256     ENABLE_SYSTEM_JSONCPP=ON   - Use JsonCPP from system
 257     OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference
 258     RUN_IN_PLACE=FALSE         - Create a portable install (worlds, settings etc. in current directory)
 259     USE_GPROF=FALSE            - Enable profiling using GProf
 260     VERSION_EXTRA=             - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 261
 262 Library specific options:
 263
 264     CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 265     CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 266     CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 267     EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 268     EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
 269     FREETYPE_INCLUDE_DIR_freetype2  - Only if building with FreeType 2; directory that contains an freetype directory with files such as ftimage.h in it
 270     FREETYPE_INCLUDE_DIR_ft2build   - Only if building with FreeType 2; directory that contains ft2build.h
 271     FREETYPE_LIBRARY                - Only if building with FreeType 2; path to libfreetype.a/libfreetype.so/freetype.lib
 272     FREETYPE_DLL                    - Only if building with FreeType 2 on Windows; path to libfreetype.dll
 273     GETTEXT_DLL                     - Only when building with gettext on Windows; paths to libintl + libiconv DLLs
 274     GETTEXT_INCLUDE_DIR             - Only when building with gettext; directory that contains iconv.h
 275     GETTEXT_LIBRARY                 - Only when building with gettext on Windows; path to libintl.dll.a
 276     GETTEXT_MSGFMT                  - Only when building with gettext; path to msgfmt/msgfmt.exe
 277     IRRLICHT_DLL                    - Only on Windows; path to IrrlichtMt.dll
 278     IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h
 279     IRRLICHT_LIBRARY                - Path to libIrrlichtMt.a/libIrrlichtMt.so/libIrrlichtMt.dll.a/IrrlichtMt.lib
 280     LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 281     LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
 282     LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 283     PostgreSQL_INCLUDE_DIR          - Only when building with PostgreSQL; directory that contains libpq-fe.h
 284     PostgreSQL_LIBRARY              - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib
 285     REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
 286     REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
 287     SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
 288     SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
 289     LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 290     LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 291     OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
 292     OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
 293     OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
 294     OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
 295     OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
 296     OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
 297     OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
 298     OPENGLES2_LIBRARY               - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
 299     SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
 300     SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
 301     VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 302     VORBIS_DLL                      - Only if building with sound on Windows; paths to vorbis DLLs
 303     VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 304     VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 305     XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
 306     ZLIB_DLL                        - Only on Windows; path to zlib1.dll
 307     ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
 308     ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlib.lib
 309
 310 ### Compiling on Windows
 311
 312 ### Requirements
 313
 314 - [Visual Studio 2015 or newer](https://visualstudio.microsoft.com)
 315 - [CMake](https://cmake.org/download/)
 316 - [vcpkg](https://github.com/Microsoft/vcpkg)
 317 - [Git](https://git-scm.com/downloads)
 318
 319 ### Compiling and installing the dependencies
 320
 321 It is highly recommended to use vcpkg as package manager.
 322
 323 #### a) Using vcpkg to install dependencies
 324
 325 After you successfully built vcpkg you can easily install the required libraries:
 326 ```powershell
 327 vcpkg install zlib curl[winssl] openal-soft libvorbis libogg sqlite3 freetype luajit gmp jsoncpp --triplet x64-windows
 328 ```
 329
 330 - **Note that you currently need to build irrlicht on your own**
 331 - `curl` is optional, but required to read the serverlist, `curl[winssl]` is required to use the content store.
 332 - `openal-soft`, `libvorbis` and `libogg` are optional, but required to use sound.
 333 - `freetype` is optional, it allows true-type font rendering.
 334 - `luajit` is optional, it replaces the integrated Lua interpreter with a faster just-in-time interpreter.
 335 - `gmp` and `jsoncpp` are optional, otherwise the bundled versions will be compiled
 336
 337 There are other optional libraries, but they are not tested if they can build and link correctly.
 338
 339 Use `--triplet` to specify the target triplet, e.g. `x64-windows` or `x86-windows`.
 340
 341 #### b) Compile the dependencies on your own
 342
 343 This is outdated and not recommended. Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
 344
 345 ### Compile Minetest
 346
 347 #### a) Using the vcpkg toolchain and CMake GUI
 348 1. Start up the CMake GUI
 349 2. Select **Browse Source...** and select DIR/minetest
 350 3. Select **Browse Build...** and select DIR/minetest-build
 351 4. Select **Configure**
 352 5. Choose the right visual Studio version and target platform. It has to match the version of the installed dependencies
 353 6. Choose **Specify toolchain file for cross-compiling**
 354 7. Click **Next**
 355 8. Select the vcpkg toolchain file e.g. `D:/vcpkg/scripts/buildsystems/vcpkg.cmake`
 356 9. Click Finish
 357 10. Wait until cmake have generated the cash file
 358 11. If there are any errors, solve them and hit **Configure**
 359 12. Click **Generate**
 360 13. Click **Open Project**
 361 14. Compile Minetest inside Visual studio.
 362
 363 #### b) Using the vcpkg toolchain and the commandline
 364
 365 Run the following script in PowerShell:
 366
 367 ```powershell
 368 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
 369 cmake --build . --config Release
 370 ```
 371 Make sure that the right compiler is selected and the path to the vcpkg toolchain is correct.
 372
 373 #### c) Using your own compiled libraries
 374
 375 **This is outdated and not recommended**
 376
 377 Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
 378
 379 ### Windows Installer using WiX Toolset
 380
 381 Requirements:
 382 * [Visual Studio 2017](https://visualstudio.microsoft.com/)
 383 * [WiX Toolset](https://wixtoolset.org/)
 384
 385 In the Visual Studio 2017 Installer select **Optional Features -> WiX Toolset**.
 386
 387 Build the binaries as described above, but make sure you unselect `RUN_IN_PLACE`.
 388
 389 Open the generated project file with Visual Studio. Right-click **Package** and choose **Generate**.
 390 It may take some minutes to generate the installer.
 391
 392
 393 Docker
 394 ------
 395 We provide Minetest server Docker images using the GitLab mirror registry.
 396
 397 Images are built on each commit and available using the following tag scheme:
 398
 399 * `registry.gitlab.com/minetest/minetest/server:latest` (latest build)
 400 * `registry.gitlab.com/minetest/minetest/server:<branch/tag>` (current branch or current tag)
 401 * `registry.gitlab.com/minetest/minetest/server:<commit-id>` (current commit id)
 402
 403 If you want to test it on a Docker server you can easily run:
 404
 405         sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
 406
 407 If you want to use it in a production environment you should use volumes bound to the Docker host
 408 to persist data and modify the configuration:
 409
 410         sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
 411
 412 Data will be written to `/home/minetest/data` on the host, and configuration will be read from `/home/minetest/conf/minetest.conf`.
 413
 414 **Note:** If you don't understand the previous commands please read the official Docker documentation before use.
 415
 416 You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in [`misc/kubernetes.yml`](misc/kubernetes.yml).
 417
 418
 419 Version scheme
 420 --------------
 421 We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
 422
 423 - Major is incremented when the release contains breaking changes, all other
 424 numbers are set to 0.
 425 - Minor is incremented when the release contains new non-breaking features,
 426 patch is set to 0.
 427 - Patch is incremented when the release only contains bugfixes and very
 428 minor/trivial features considered necessary.
 429
 430 Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
 431 i.e.: 5.0.0-dev is the development version leading to 5.0.0.
 432 Prior to that we used `previous_version-dev`.