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)
8 An InfiniMiner/Minecraft inspired game.
10 Copyright (c) 2010-2018 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.
20 ----------------------
21 - Website: http://minetest.net/
22 - Wiki: http://wiki.minetest.net/
23 - Developer wiki: http://dev.minetest.net/
24 - Forum: http://forum.minetest.net/
25 - Github: https://github.com/minetest/minetest/
26 - doc/ directory of source distribution
28 This game is not finished
29 --------------------------
30 - Don't expect it to work as well as a finished game will.
31 - Please report any bugs. When doing that, debug.txt is useful.
35 All controls are re-bindable using settings.
36 Some can be changes in the key config dialog in the settings tab.
39 |-------------------------------|----------------------------------------------------------------|
40 | Move mouse | Look around |
42 | Space | Jump/move up |
43 | Shift | Sneak/move down |
44 | Q | Drop itemstack |
45 | Shift + Q | Drop single item |
46 | Left mouse button | Dig/punch/take item |
47 | Right mouse button | Place/use |
48 | Shift + right mouse button | Build (without using) |
49 | I | Inventory menu |
50 | Mouse wheel | Select item |
52 | Z | Zoom (needs zoom privilege) |
55 | Esc | Pause menu/abort/exit (pauses only singleplayer game) |
56 | R | Enable/disable full range view |
57 | + | Increase view range |
58 | - | Decrease view range |
59 | K | Enable/disable fly mode (needs fly privilege) |
60 | J | Enable/disable fast mode (needs fast privilege) |
61 | H | Enable/disable noclip mode (needs noclip privilege) |
62 | E | Move fast in fast mode |
63 | F1 | Hide/show HUD |
64 | F2 | Hide/show chat |
65 | F3 | Disable/enable fog |
66 | F4 | Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds) |
67 | F5 | Cycle through debug info screens |
68 | F6 | Cycle through profiler info screens |
69 | F7 | Cycle through camera modes |
70 | F8 | Toggle cinematic mode |
71 | F9 | Cycle through minimap modes |
72 | Shift + F9 | Change minimap orientation |
73 | F10 | Show/hide console |
74 | F12 | Take screenshot |
81 * bin - Compiled binaries
82 * share - Distributed read-only data
83 * user - User-created modifiable data
85 Where each location is on each platform:
87 * Windows .zip / RUN_IN_PLACE source:
93 * share = /usr/share/minetest
96 * bin = Contents/MacOS
97 * share = Contents/Resources
98 * user = Contents/User OR ~/Library/Application Support/minetest
100 Worlds can be found as separate folders in: user/worlds/
106 - It is created by Minetest when it is ran the first time.
107 - A specific file can be specified on the command line:
108 `--config <path-to-file>`
109 - A run-in-place build will look for the configuration file in
110 `location_of_exe/../minetest.conf` and also `location_of_exe/../../minetest.conf`
112 Command-line options:
113 ---------------------
119 ### Compiling on GNU/Linux
123 | Dependency | Version | Commentary |
124 |------------|---------|------------|
125 | GCC | 4.9+ | Can be replaced with Clang 3.4+ |
127 | Irrlicht | 1.7.3+ | |
129 | LuaJIT | 2.0+ | Bundled Lua 5.1 is used if not present |
130 | GMP | 5.0.0+ | Bundled mini-GMP is used if not present |
131 | JsonCPP | 1.0.0+ | Bundled JsonCPP is used if not present |
135 $ sudo apt-get 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
139 $ sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libcurl* openal* libvorbis* 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
143 You can install git for easily keeping your copy up to date.
144 If you don’t want git, read below on how to get the source without git.
145 This is an example for installing git on Debian/Ubuntu:
147 $ sudo apt-get install git
151 $ sudo dnf install git
153 Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
155 $ git clone --depth 1 https://github.com/minetest/minetest.git
158 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
160 $ git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
162 Download source, without using git:
164 $ wget https://github.com/minetest/minetest/archive/master.tar.gz
165 $ tar xf master.tar.gz
168 Download minetest_game, without using git:
171 $ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
172 $ tar xf master.tar.gz
173 $ mv minetest_game-master minetest_game
178 Build a version that runs directly from the source directory:
180 $ cmake . -DRUN_IN_PLACE=TRUE
181 $ make -j <number of processors>
187 - Use cmake . -LH to see all CMake options and their current state
188 - If you want to install it system-wide (or are making a distribution package),
189 you will want to use -DRUN_IN_PLACE=FALSE
190 - You can build a bare server by specifying -DBUILD_SERVER=TRUE
191 - You can disable the client build by specifying -DBUILD_CLIENT=FALSE
192 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
193 - Debug build is slower, but gives much more useful output in a debugger
194 - If you build a bare server, you don't need to have Irrlicht installed.
195 In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
201 BUILD_CLIENT - Build Minetest client
202 BUILD_SERVER - Build Minetest server
203 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
204 Release - Release build
206 SemiDebug - Partially optimized debug build
207 RelWithDebInfo - Release build with Debug information
208 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
209 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
210 ENABLE_CURSES - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
211 ENABLE_FREETYPE - Build with FreeType2; Allows using TTF fonts
212 ENABLE_GETTEXT - Build with Gettext; Allows using translations
213 ENABLE_GLES - Search for Open GLES headers & libraries and use them
214 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB map backend
215 ENABLE_POSTGRESQL - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
216 ENABLE_REDIS - Build with libhiredis; Enables use of Redis map backend
217 ENABLE_SPATIAL - Build with LibSpatial; Speeds up AreaStores
218 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
219 ENABLE_LUAJIT - Build with LuaJIT (much faster than non-JIT Lua)
220 ENABLE_SYSTEM_GMP - Use GMP from system (much faster than bundled mini-gmp)
221 ENABLE_SYSTEM_JSONCPP - Use JsonCPP from system
222 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
223 USE_GPROF - Enable profiling using GProf
224 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
226 Library specific options:
228 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
229 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
230 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
231 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
232 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
233 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
234 EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
235 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
236 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
237 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
238 FREETYPE_DLL - Only if building with Freetype2 on Windows; path to libfreetype.dll
239 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
240 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
241 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
242 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
243 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
244 IRRLICHT_DLL - Only on Windows; path to Irrlicht.dll
245 IRRLICHT_INCLUDE_DIR - Directory that contains IrrCompileConfig.h
246 IRRLICHT_LIBRARY - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
247 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
248 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
249 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
250 PostgreSQL_INCLUDE_DIR - Only when building with PostgreSQL; directory that contains libpq-fe.h
251 POSTGRESQL_LIBRARY - Only when building with PostgreSQL; path to libpq.a/libpq.so
252 REDIS_INCLUDE_DIR - Only when building with Redis; directory that contains hiredis.h
253 REDIS_LIBRARY - Only when building with Redis; path to libhiredis.a/libhiredis.so
254 SPATIAL_INCLUDE_DIR - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
255 SPATIAL_LIBRARY - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
256 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
257 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
258 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
259 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
260 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
261 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
262 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
263 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
264 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
265 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
266 OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
267 SQLITE3_INCLUDE_DIR - Directory that contains sqlite3.h
268 SQLITE3_LIBRARY - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
269 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
270 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
271 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
272 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
273 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
274 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
275 ZLIB_DLL - Only on Windows; path to zlib1.dll
276 ZLIBWAPI_DLL - Only on Windows; path to zlibwapi.dll
277 ZLIB_INCLUDE_DIR - Directory that contains zlib.h
278 ZLIB_LIBRARY - Path to libz.a/libz.so/zlibwapi.lib
280 ### Compiling on Windows
282 * This section is outdated. In addition to what is described here:
283 * In addition to minetest, you need to download minetest_game.
284 * If you wish to have sound support, you need libogg, libvorbis and libopenal
288 http://www.cmake.org/cmake/resources/software.html
290 * MinGW: http://www.mingw.org/
291 * or Visual Studio: http://msdn.microsoft.com/en-us/vstudio/default
293 http://irrlicht.sourceforge.net/downloads.html
294 * Zlib headers (zlib125.zip)
295 http://www.winimage.com/zLibDll/index.html
296 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
297 http://www.winimage.com/zLibDll/index.html
298 * SQLite3 headers and library
299 https://www.sqlite.org/download.html
300 * Optional: gettext library and tools:
301 http://gnuwin32.sourceforge.net/downlinks/gettext.php
302 * This is used for other UI languages. Feel free to leave it out.
303 * And, of course, Minetest:
304 http://minetest.net/download
306 * Select a directory called DIR hereafter in which you will operate.
307 * Make sure you have CMake and a compiler installed.
308 * Download all the other stuff to DIR and extract them into there.
309 ("extract here", not "extract to packagename/")
310 * NOTE: zlib125dll.zip needs to be extracted into zlib125dll
311 * NOTE: You need to extract sqlite3.h & sqlite3ext.h from sqlite3 source
312 and sqlite3.dll & sqlite3.def from sqlite3 precompiled binaries
313 into "sqlite3" directory, and generate sqlite3.lib using command
314 "LIB /DEF:sqlite3.def /OUT:sqlite3.lib"
315 * All those packages contain a nice base directory in them, which
316 should end up being the direct subdirectories of DIR.
317 * You will end up with a directory structure like this (+=dir, -=file):
323 * sqlite-amalgamation-3130000.zip (SQLite3 headers)
324 * sqlite-dll-win32-x86-3130000.zip (SQLite3 library for 32bit system)
325 * 110214175330.zip (or whatever, this is the minetest source)
353 * Start up the CMake GUI
354 * Select "Browse Source..." and select DIR/minetest
355 * Now, if using MSVC:
356 * Select "Browse Build..." and select DIR/minetest-build
357 * Else if using MinGW:
358 * Select "Browse Build..." and select DIR/minetest
360 * Select your compiler
361 * It will warn about missing stuff, ignore that at this point. (later don't)
362 * Make sure the configuration is as follows
363 (note that the versions may differ for you):
367 CMAKE_BUILD_TYPE Release
368 CMAKE_INSTALL_PREFIX DIR/minetest-install
369 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.8.3
372 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
373 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
374 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
375 GETTEXT_BIN_DIR DIR/gettext/bin
376 GETTEXT_INCLUDE_DIR DIR/gettext/include
377 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
378 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
380 * If CMake complains it couldn't find SQLITE3, choose "Advanced" box on the
381 right top corner, then specify the location of SQLITE3_INCLUDE_DIR and
382 SQLITE3_LIBRARY manually.
383 * If you want to build 64-bit minetest, you will need to build 64-bit version
384 of irrlicht engine manually, as only 32-bit pre-built library is provided.
386 * Hit "Configure" once again 8)
387 * If something is still coloured red, you have a problem.
390 * Open the generated minetest.sln
391 * The project defaults to the "Debug" configuration. Make very sure to
392 select "Release", unless you want to debug some stuff (it's slower
393 and might not even work at all)
394 * Build the ALL_BUILD project
395 * Build the INSTALL project
396 * You should now have a working game with the executable in
397 DIR/minetest-install/bin/minetest.exe
398 * Additionally you may create a zip package by building the PACKAGE
401 * Using the command line, browse to the build directory and run 'make'
402 (or mingw32-make or whatever it happens to be)
403 * You may need to copy some of the downloaded DLLs into bin/, see what
404 running the produced executable tells you it doesn't have.
405 * You should now have a working game with the executable in
406 DIR/minetest/bin/minetest.exe
408 ### Bat script to build Windows releases of Minetest
410 This is how we build Windows releases.
413 set installpath="C:\tmp\minetest_install"
414 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
416 set builddir=%sourcedir%\bvc10
419 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
420 if %errorlevel% neq 0 goto fail
421 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
422 if %errorlevel% neq 0 goto fail
423 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
424 if %errorlevel% neq 0 goto fail
425 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
426 if %errorlevel% neq 0 goto fail
439 Minetest doesn't follow semver. Instead, we do something roughly similar to 0.major.minor.
441 Since 0.5.0-dev and 0.4.17-dev, the dev notation refers to the next release,
442 ie: 0.5.0-dev is the development version leading to 0.5.0.
444 Prior to that, we used oldversion-dev.