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)
8 Minetest is a free open-source voxel game engine with easy modding and game creation.
10 Copyright (C) 2010-2020 Perttu Ahola <celeron55@gmail.com>
11 and contributors (see source file comments and the version control log)
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.
22 1. [Further Documentation](#further-documentation)
23 2. [Default Controls](#default-controls)
25 4. [Configuration File](#configuration-file)
26 5. [Command-line Options](#command-line-options)
27 6. [Compiling](#compiling)
29 8. [Version Scheme](#version-scheme)
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
43 All controls are re-bindable using settings.
44 Some can be changed in the key config dialog in the settings tab.
47 |-------------------------------|----------------------------------------------------------------|
48 | Move mouse | Look around |
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 |
60 | Z | Zoom (needs zoom privilege) |
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 | 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 |
88 * `bin` - Compiled binaries
89 * `share` - Distributed read-only data
90 * `user` - User-created modifiable data
92 Where each location is on each platform:
94 * Windows .zip / RUN_IN_PLACE source:
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`
104 * `share` = `/usr/share/minetest`
105 * `user` = `~/.minetest`
107 * `bin` = `Contents/MacOS`
108 * `share` = `Contents/Resources`
109 * `user` = `Contents/User OR ~/Library/Application Support/minetest`
111 Worlds can be found as separate folders in: `user/worlds/`
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`
129 ### Compiling on GNU/Linux
133 | Dependency | Version | Commentary |
134 |------------|---------|------------|
135 | GCC | 4.9+ | Can be replaced with Clang 3.4+ |
137 | Irrlicht | 1.7.3+ | |
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 |
143 For Debian/Ubuntu users:
145 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
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
153 sudo pacman -S base-devel libcurl-gnutls cmake libxxf86vm irrlicht libpng sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses
157 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
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:
171 Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
173 git clone --depth 1 https://github.com/minetest/minetest.git
176 Download minetest_game (otherwise only the "Minimal development test" game is available) using Git:
178 git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
180 Download source, without using Git:
182 wget https://github.com/minetest/minetest/archive/master.tar.gz
186 Download minetest_game, without using Git:
189 wget https://github.com/minetest/minetest_game/archive/master.tar.gz
191 mv minetest_game-master minetest_game
196 Build a version that runs directly from the source directory:
198 cmake . -DRUN_IN_PLACE=TRUE
205 - Use `cmake . -LH` to see all CMake options and their current state.
206 - If you want to install it system-wide (or are making a distribution package),
207 you will want to use `-DRUN_IN_PLACE=FALSE`.
208 - You can build a bare server by specifying `-DBUILD_SERVER=TRUE`.
209 - You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`.
210 - You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`.
211 - Debug build is slower, but gives much more useful output in a debugger.
212 - If you build a bare server you don't need to have Irrlicht installed.
213 - In that case use `-DIRRLICHT_SOURCE_DIR=/the/irrlicht/source`.
217 General options and their default values:
219 BUILD_CLIENT=TRUE - Build Minetest client
220 BUILD_SERVER=FALSE - Build Minetest server
221 BUILD_UNITTESTS=TRUE - Build unittest sources
222 CMAKE_BUILD_TYPE=Release - Type of build (Release vs. Debug)
223 Release - Release build
225 SemiDebug - Partially optimized debug build
226 RelWithDebInfo - Release build with debug information
227 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
228 ENABLE_CURL=ON - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
229 ENABLE_CURSES=ON - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
230 ENABLE_FREETYPE=ON - Build with FreeType2; Allows using TTF fonts
231 ENABLE_GETTEXT=ON - Build with Gettext; Allows using translations
232 ENABLE_GLES=OFF - Build for OpenGL ES instead of OpenGL (requires support by Irrlicht)
233 ENABLE_LEVELDB=ON - Build with LevelDB; Enables use of LevelDB map backend
234 ENABLE_POSTGRESQL=ON - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
235 ENABLE_REDIS=ON - Build with libhiredis; Enables use of Redis map backend
236 ENABLE_SPATIAL=ON - Build with LibSpatial; Speeds up AreaStores
237 ENABLE_SOUND=ON - Build with OpenAL, libogg & libvorbis; in-game sounds
238 ENABLE_LUAJIT=ON - Build with LuaJIT (much faster than non-JIT Lua)
239 ENABLE_SYSTEM_GMP=ON - Use GMP from system (much faster than bundled mini-gmp)
240 ENABLE_SYSTEM_JSONCPP=OFF - Use JsonCPP from system
241 OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference
242 RUN_IN_PLACE=FALSE - Create a portable install (worlds, settings etc. in current directory)
243 USE_GPROF=FALSE - Enable profiling using GProf
244 VERSION_EXTRA= - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
246 Library specific options:
248 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
249 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
250 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
251 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
252 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
253 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
254 EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
255 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with FreeType 2; directory that contains an freetype directory with files such as ftimage.h in it
256 FREETYPE_INCLUDE_DIR_ft2build - Only if building with FreeType 2; directory that contains ft2build.h
257 FREETYPE_LIBRARY - Only if building with FreeType 2; path to libfreetype.a/libfreetype.so/freetype.lib
258 FREETYPE_DLL - Only if building with FreeType 2 on Windows; path to libfreetype.dll
259 GETTEXT_DLL - Only when building with gettext on Windows; path to libintl3.dll
260 GETTEXT_ICONV_DLL - Only when building with gettext on Windows; path to libiconv2.dll
261 GETTEXT_INCLUDE_DIR - Only when building with gettext; directory that contains iconv.h
262 GETTEXT_LIBRARY - Only when building with gettext on Windows; path to libintl.dll.a
263 GETTEXT_MSGFMT - Only when building with gettext; path to msgfmt/msgfmt.exe
264 IRRLICHT_DLL - Only on Windows; path to Irrlicht.dll
265 IRRLICHT_INCLUDE_DIR - Directory that contains IrrCompileConfig.h
266 IRRLICHT_LIBRARY - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
267 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
268 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
269 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
270 PostgreSQL_INCLUDE_DIR - Only when building with PostgreSQL; directory that contains libpq-fe.h
271 PostgreSQL_LIBRARY - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib
272 REDIS_INCLUDE_DIR - Only when building with Redis; directory that contains hiredis.h
273 REDIS_LIBRARY - Only when building with Redis; path to libhiredis.a/libhiredis.so
274 SPATIAL_INCLUDE_DIR - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
275 SPATIAL_LIBRARY - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
276 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
277 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
278 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
279 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
280 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
281 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
282 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
283 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
284 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
285 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
286 OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
287 SQLITE3_INCLUDE_DIR - Directory that contains sqlite3.h
288 SQLITE3_LIBRARY - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
289 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
290 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
291 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
292 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
293 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
294 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
295 ZLIB_DLL - Only on Windows; path to zlib1.dll
296 ZLIB_INCLUDE_DIR - Directory that contains zlib.h
297 ZLIB_LIBRARY - Path to libz.a/libz.so/zlib.lib
299 ### Compiling on Windows
303 - [Visual Studio 2015 or newer](https://visualstudio.microsoft.com)
304 - [CMake](https://cmake.org/download/)
305 - [vcpkg](https://github.com/Microsoft/vcpkg)
306 - [Git](https://git-scm.com/downloads)
308 ### Compiling and installing the dependencies
310 It is highly recommended to use vcpkg as package manager.
312 #### a) Using vcpkg to install dependencies
314 After you successfully built vcpkg you can easily install the required libraries:
316 vcpkg install irrlicht zlib curl[winssl] openal-soft libvorbis libogg sqlite3 freetype luajit --triplet x64-windows
319 - `curl` is optional, but required to read the serverlist, `curl[winssl]` is required to use the content store.
320 - `openal-soft`, `libvorbis` and `libogg` are optional, but required to use sound.
321 - `freetype` is optional, it allows true-type font rendering.
322 - `luajit` is optional, it replaces the integrated Lua interpreter with a faster just-in-time interpreter.
324 There are other optional libraries, but they are not tested if they can build and link correctly.
326 Use `--triplet` to specify the target triplet, e.g. `x64-windows` or `x86-windows`.
328 #### b) Compile the dependencies on your own
330 This is outdated and not recommended. Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
334 #### a) Using the vcpkg toolchain and CMake GUI
335 1. Start up the CMake GUI
336 2. Select **Browse Source...** and select DIR/minetest
337 3. Select **Browse Build...** and select DIR/minetest-build
338 4. Select **Configure**
339 5. Choose the right visual Studio version and target platform. It has to match the version of the installed dependencies
340 6. Choose **Specify toolchain file for cross-compiling**
342 8. Select the vcpkg toolchain file e.g. `D:/vcpkg/scripts/buildsystems/vcpkg.cmake`
344 10. Wait until cmake have generated the cash file
345 11. If there are any errors, solve them and hit **Configure**
346 12. Click **Generate**
347 13. Click **Open Project**
348 14. Compile Minetest inside Visual studio.
350 #### b) Using the vcpkg toolchain and the commandline
352 Run the following script in PowerShell:
355 cmake . -G"Visual Studio 15 2017 Win64" -DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_GETTEXT=0 -DENABLE_CURSES=0
356 cmake --build . --config Release
358 Make sure that the right compiler is selected and the path to the vcpkg toolchain is correct.
360 #### c) Using your own compiled libraries
362 **This is outdated and not recommended**
364 Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
366 ### Windows Installer using WiX Toolset
369 * [Visual Studio 2017](https://visualstudio.microsoft.com/)
370 * [WiX Toolset](https://wixtoolset.org/)
372 In the Visual Studio 2017 Installer select **Optional Features -> WiX Toolset**.
374 Build the binaries as described above, but make sure you unselect `RUN_IN_PLACE`.
376 Open the generated project file with Visual Studio. Right-click **Package** and choose **Generate**.
377 It may take some minutes to generate the installer.
382 We provide Minetest server Docker images using the GitLab mirror registry.
384 Images are built on each commit and available using the following tag scheme:
386 * `registry.gitlab.com/minetest/minetest/server:latest` (latest build)
387 * `registry.gitlab.com/minetest/minetest/server:<branch/tag>` (current branch or current tag)
388 * `registry.gitlab.com/minetest/minetest/server:<commit-id>` (current commit id)
390 If you want to test it on a Docker server you can easily run:
392 sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
394 If you want to use it in a production environment you should use volumes bound to the Docker host
395 to persist data and modify the configuration:
397 sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
399 Data will be written to `/home/minetest/data` on the host, and configuration will be read from `/home/minetest/conf/minetest.conf`.
401 **Note:** If you don't understand the previous commands please read the official Docker documentation before use.
403 You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in [`misc/kubernetes.yml`](misc/kubernetes.yml).
408 We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
410 - Major is incremented when the release contains breaking changes, all other
411 numbers are set to 0.
412 - Minor is incremented when the release contains new non-breaking features,
414 - Patch is incremented when the release only contains bugfixes and very
415 minor/trivial features considered necessary.
417 Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
418 i.e.: 5.0.0-dev is the development version leading to 5.0.0.
419 Prior to that we used `previous_version-dev`.