Minetest is a free open-source voxel game engine with easy modding and game creation.
Copyright (C) 2010-2019 Perttu Ahola firstname.lastname@example.org and contributors (see source file comments and the version control log)
In case you downloaded the source code
If you downloaded the Minetest Engine source code in which this file is contained, you probably want to download the Minetest Game project too. See its README.txt for more information.
Table of Contents
- Further Documentation
- Default Controls
- Configuration File
- Command-line Options
- Version Scheme
- Website: http://minetest.net/
- Wiki: http://wiki.minetest.net/
- Developer wiki: http://dev.minetest.net/
- Forum: http://forum.minetest.net/
- GitHub: https://github.com/minetest/minetest/
- doc/ directory of source distribution
All controls are re-bindable using settings. Some can be changed in the key config dialog in the settings tab.
|Move mouse||Look around|
|W, A, S, D||Move|
|Shift + Q||Drop single item|
|Left mouse button||Dig/punch/take item|
|Right mouse button||Place/use|
|Shift + right mouse button||Build (without using)|
|Mouse wheel||Select item|
|Z||Zoom (needs zoom privilege)|
|Esc||Pause menu/abort/exit (pauses only singleplayer game)|
|R||Enable/disable full range view|
|+||Increase view range|
|-||Decrease view range|
|K||Enable/disable fly mode (needs fly privilege)|
|P||Enable/disable pitch move mode|
|J||Enable/disable fast mode (needs fast privilege)|
|H||Enable/disable noclip mode (needs noclip privilege)|
|E||Move fast in fast mode|
|F4||Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)|
|F5||Cycle through debug information screens|
|F6||Cycle through profiler info screens|
|F7||Cycle through camera modes|
|F9||Cycle through minimap modes|
|Shift + F9||Change minimap orientation|
bin- Compiled binaries
share- Distributed read-only data
user- User-created modifiable data
Where each location is on each platform:
- Windows .zip / RUN_IN_PLACE source:
- Windows installed:
C:\Program Files\Minetest\bin (Depends on the install location)
C:\Program Files\Minetest (Depends on the install location)
- Linux installed:
Contents/User OR ~/Library/Application Support/minetest
Worlds can be found as separate folders in:
- Default location:
- This file is created by closing Minetest for the first time.
- A specific file can be specified on the command line:
- A run-in-place build will look for the configuration file in
Compiling on GNU/Linux
|GCC||4.9+||Can be replaced with Clang 3.4+|
|LuaJIT||2.0+||Bundled Lua 5.1 is used if not present|
|GMP||5.0.0+||Bundled mini-GMP is used if not present|
|JsonCPP||1.0.0+||Bundled JsonCPP is used if not present|
For Debian/Ubuntu users:
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
For Fedora users:
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
For Arch users:
sudo pacman -S base-devel libcurl-gnutls cmake libxxf86vm irrlicht libpng sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses
You can install Git for easily keeping your copy up to date. If you don’t want Git, read below on how to get the source without Git. This is an example for installing Git on Debian/Ubuntu:
sudo apt install git
For Fedora users:
sudo dnf install git
Download source (this is the URL to the latest of source repository, which might not work at all times) using Git:
git clone --depth 1 https://github.com/minetest/minetest.git cd minetest
Download minetest_game (otherwise only the "Minimal development test" game is available) using Git:
git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
Download source, without using Git:
wget https://github.com/minetest/minetest/archive/master.tar.gz tar xf master.tar.gz cd minetest-master
Download minetest_game, without using Git:
cd games/ wget https://github.com/minetest/minetest_game/archive/master.tar.gz tar xf master.tar.gz mv minetest_game-master minetest_game cd ..
Build a version that runs directly from the source directory:
cmake . -DRUN_IN_PLACE=TRUE make -j$(nproc)
cmake . -LHto see all CMake options and their current state.
- If you want to install it system-wide (or are making a distribution package),
you will want to use
- You can build a bare server by specifying
- You can disable the client build by specifying
- You can select between Release and Debug build by
-DCMAKE_BUILD_TYPE=<Debug or Release>.
- Debug build is slower, but gives much more useful output in a debugger.
- If you build a bare server you don't need to have Irrlicht installed.
- In that case use
- In that case use
General options and their default values:
BUILD_CLIENT=TRUE - Build Minetest client BUILD_SERVER=FALSE - Build Minetest server CMAKE_BUILD_TYPE=Release - Type of build (Release vs. Debug) Release - Release build Debug - Debug build SemiDebug - Partially optimized debug build RelWithDebInfo - Release build with debug information MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible ENABLE_CURL=ON - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http ENABLE_CURSES=ON - Build with (n)curses; Enables a server side terminal (command line option: --terminal) ENABLE_FREETYPE=ON - Build with FreeType2; Allows using TTF fonts ENABLE_GETTEXT=ON - Build with Gettext; Allows using translations ENABLE_GLES=OFF - Build for OpenGL ES instead of OpenGL (requires support by Irrlicht) ENABLE_LEVELDB=ON - Build with LevelDB; Enables use of LevelDB map backend ENABLE_POSTGRESQL=ON - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended) ENABLE_REDIS=ON - Build with libhiredis; Enables use of Redis map backend ENABLE_SPATIAL=ON - Build with LibSpatial; Speeds up AreaStores ENABLE_SOUND=ON - Build with OpenAL, libogg & libvorbis; in-game sounds ENABLE_LUAJIT=ON - Build with LuaJIT (much faster than non-JIT Lua) ENABLE_SYSTEM_GMP=ON - Use GMP from system (much faster than bundled mini-gmp) ENABLE_SYSTEM_JSONCPP=OFF - Use JsonCPP from system OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference RUN_IN_PLACE=FALSE - Create a portable install (worlds, settings etc. in current directory) USE_GPROF=FALSE - Enable profiling using GProf VERSION_EXTRA= - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
Library specific options:
BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so FREETYPE_INCLUDE_DIR_freetype2 - Only if building with FreeType 2; directory that contains an freetype directory with files such as ftimage.h in it FREETYPE_INCLUDE_DIR_ft2build - Only if building with FreeType 2; directory that contains ft2build.h FREETYPE_LIBRARY - Only if building with FreeType 2; path to libfreetype.a/libfreetype.so/freetype.lib FREETYPE_DLL - Only if building with FreeType 2 on Windows; path to libfreetype.dll GETTEXT_DLL - Only when building with gettext on Windows; path to libintl3.dll GETTEXT_ICONV_DLL - Only when building with gettext on Windows; path to libiconv2.dll GETTEXT_INCLUDE_DIR - Only when building with gettext; directory that contains iconv.h GETTEXT_LIBRARY - Only when building with gettext on Windows; path to libintl.dll.a GETTEXT_MSGFMT - Only when building with gettext; path to msgfmt/msgfmt.exe IRRLICHT_DLL - Only on Windows; path to Irrlicht.dll IRRLICHT_INCLUDE_DIR - Directory that contains IrrCompileConfig.h IRRLICHT_LIBRARY - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll PostgreSQL_INCLUDE_DIR - Only when building with PostgreSQL; directory that contains libpq-fe.h PostgreSQL_LIBRARY - Only when building with PostgreSQL; path to libpq.a/libpq.so/libpq.lib REDIS_INCLUDE_DIR - Only when building with Redis; directory that contains hiredis.h REDIS_LIBRARY - Only when building with Redis; path to libhiredis.a/libhiredis.so SPATIAL_INCLUDE_DIR - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h SPATIAL_LIBRARY - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll OGG_DLL - Only if building with sound on Windows; path to libogg.dll OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so SQLITE3_INCLUDE_DIR - Directory that contains sqlite3.h SQLITE3_LIBRARY - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so ZLIB_DLL - Only on Windows; path to zlib1.dll ZLIB_INCLUDE_DIR - Directory that contains zlib.h ZLIB_LIBRARY - Path to libz.a/libz.so/zlib.lib
Compiling on Windows
Compiling and installing the dependencies
It is highly recommended to use vcpkg as package manager.
a) Using vcpkg to install dependencies
After you successfully built vcpkg you can easily install the required libraries:
vcpkg install irrlicht zlib curl[winssl] openal-soft libvorbis libogg sqlite3 freetype luajit --triplet x64-windows
curlis optional, but required to read the serverlist,
curl[winssl]is required to use the content store.
liboggare optional, but required to use sound.
freetypeis optional, it allows true-type font rendering.
luajitis optional, it replaces the integrated Lua interpreter with a faster just-in-time interpreter.
There are other optional libraries, but they are not tested if they can build and link correctly.
--triplet to specify the target triplet, e.g.
b) Compile the dependencies on your own
This is outdated and not recommended. Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
a) Using the vcpkg toolchain and CMake GUI
- Start up the CMake GUI
- Select Browse Source... and select DIR/minetest
- Select Browse Build... and select DIR/minetest-build
- Select Configure
- Choose the right visual Studio version and target platform. It has to match the version of the installed dependencies
- Choose Specify toolchain file for cross-compiling
- Click Next
- Select the vcpkg toolchain file e.g.
- Click Finish
- Wait until cmake have generated the cash file
- If there are any errors, solve them and hit Configure
- Click Generate
- Click Open Project
- Compile Minetest inside Visual studio.
b) Using the vcpkg toolchain and the commandline
Run the following script in PowerShell:
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 cmake --build . --config Release
Make sure that the right compiler is selected and the path to the vcpkg toolchain is correct.
c) Using your own compiled libraries
This is outdated and not recommended
Follow the instructions on https://dev.minetest.net/Build_Win32_Minetest_including_all_required_libraries#VS2012_Build
Windows Installer using WiX Toolset
In the Visual Studio 2017 Installer select Optional Features -> WiX Toolset.
Build the binaries as described above, but make sure you unselect
Open the generated project file with Visual Studio. Right-click Package and choose Generate. It may take some minutes to generate the installer.
We provide Minetest server Docker images using the GitLab mirror registry.
Images are built on each commit and available using the following tag scheme:
registry.gitlab.com/minetest/minetest/server:<branch/tag>(current branch or current tag)
registry.gitlab.com/minetest/minetest/server:<commit-id>(current commit id)
If you want to test it on a Docker server you can easily run:
sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>
If you want to use it in a production environment you should use volumes bound to the Docker host to persist data and modify the configuration:
sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master
Data will be written to
/home/minetest/data on the host, and configuration will be read from
Note: If you don't understand the previous commands please read the official Docker documentation before use.
You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in
major.minor.patch since 5.0.0-dev. Prior to that we used
- Major is incremented when the release contains breaking changes, all other numbers are set to 0.
- Minor is incremented when the release contains new non-breaking features, patch is set to 0.
- Patch is incremented when the release only contains bugfixes and very minor/trivial features considered necessary.
Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
i.e.: 5.0.0-dev is the development version leading to 5.0.0.
Prior to that we used