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