README.md

   1 Minetest
   2 ========
   3
   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)
   7
   8 An InfiniMiner/Minecraft inspired game.
   9
  10 Copyright (c) 2010-2018 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 Further documentation
  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
  27
  28 Default controls
  29 ----------------
  30 All controls are re-bindable using settings.
  31 Some can be changed in the key config dialog in the settings tab.
  32
  33 | Button                        | Action                                                         |
  34 |-------------------------------|----------------------------------------------------------------|
  35 | Move mouse                    | Look around                                                    |
  36 | W, A, S, D                    | Move                                                           |
  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                                                    |
  46 | 0-9                           | Select item                                                    |
  47 | Z                             | Zoom (needs zoom privilege)                                    |
  48 | T                             | Chat                                                           |
  49 | /                             | Command                                                        |
  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                                                |
  70
  71 Paths
  72 -----
  73 Locations:
  74
  75 * `bin`   - Compiled binaries
  76 * `share` - Distributed read-only data
  77 * `user`  - User-created modifiable data
  78
  79 Where each location is on each platform:
  80
  81 * Windows .zip / RUN_IN_PLACE source:
  82     * `bin`   = `bin`
  83     * `share` = `.`
  84     * `user`  = `.`
  85 * Linux installed:
  86     * `bin`   = `/usr/bin`
  87     * `share` = `/usr/share/minetest`
  88     * `user`  = `~/.minetest`
  89 * macOS:
  90     * `bin`   = `Contents/MacOS`
  91     * `share` = `Contents/Resources`
  92     * `user`  = `Contents/User OR ~/Library/Application Support/minetest`
  93
  94 Worlds can be found as separate folders in: `user/worlds/`
  95
  96 Configuration file:
  97 -------------------
  98 - Default location:
  99     `user/minetest.conf`
 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`
 105
 106 Command-line options:
 107 ---------------------
 108 - Use `--help`
 109
 110 Compiling
 111 ---------
 112 ### Compiling on GNU/Linux
 113
 114 #### Dependencies
 115
 116 | Dependency | Version | Commentary |
 117 |------------|---------|------------|
 118 | GCC        | 4.9+    | Can be replaced with Clang 3.4+ |
 119 | CMake      | 2.6+    |            |
 120 | Irrlicht   | 1.7.3+  |            |
 121 | SQLite3    | 3.0+    |            |
 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 |
 125
 126 For Debian/Ubuntu:
 127
 128     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
 129
 130 For Fedora users:
 131
 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
 133
 134 #### Download
 135
 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:
 139
 140     sudo apt install git
 141
 142 For Fedora users:
 143
 144     sudo dnf install git
 145
 146 Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
 147
 148     git clone --depth 1 https://github.com/minetest/minetest.git
 149     cd minetest
 150
 151 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
 152
 153     git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
 154
 155 Download source, without using git:
 156
 157     wget https://github.com/minetest/minetest/archive/master.tar.gz
 158     tar xf master.tar.gz
 159     cd minetest-master
 160
 161 Download minetest_game, without using git:
 162
 163     cd games/
 164     wget https://github.com/minetest/minetest_game/archive/master.tar.gz
 165     tar xf master.tar.gz
 166     mv minetest_game-master minetest_game
 167     cd ..
 168
 169 #### Build
 170
 171 Build a version that runs directly from the source directory:
 172
 173     cmake . -DRUN_IN_PLACE=TRUE
 174     make -j <number of processors>
 175
 176 Run it:
 177
 178     ./bin/minetest
 179
 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`
 189
 190 ### CMake options
 191
 192 General options and their default values:
 193
 194     BUILD_CLIENT=TRUE          - Build Minetest client
 195     BUILD_SERVER=FALSE         - Build Minetest server
 196     CMAKE_BUILD_TYPE=Release   - Type of build (Release vs. Debug)
 197         Release                - Release build
 198         Debug                  - Debug 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=ON             - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 203     ENABLE_CURSES=ON           - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
 204     ENABLE_FREETYPE=ON         - Build with FreeType2; Allows using TTF fonts
 205     ENABLE_GETTEXT=ON          - Build with Gettext; Allows using translations
 206     ENABLE_GLES=OFF            - Search for Open GLES headers & libraries and use them
 207     ENABLE_LEVELDB=ON          - Build with LevelDB; Enables use of LevelDB map backend
 208     ENABLE_POSTGRESQL=ON       - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
 209     ENABLE_REDIS=ON            - Build with libhiredis; Enables use of Redis map backend
 210     ENABLE_SPATIAL=ON          - Build with LibSpatial; Speeds up AreaStores
 211     ENABLE_SOUND=ON            - Build with OpenAL, libogg & libvorbis; in-game Sounds
 212     ENABLE_LUAJIT=ON           - Build with LuaJIT (much faster than non-JIT Lua)
 213     ENABLE_SYSTEM_GMP=ON       - Use GMP from system (much faster than bundled mini-gmp)
 214     ENABLE_SYSTEM_JSONCPP=OFF  - Use JsonCPP from system
 215     OPENGL_GL_PREFERENCE=LEGACY - Linux client build only; See CMake Policy CMP0072 for reference
 216     RUN_IN_PLACE=FALSE         - Create a portable install (worlds, settings etc. in current directory)
 217     USE_GPROF=FALSE            - Enable profiling using GProf
 218     VERSION_EXTRA=             - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 219
 220 Library specific options:
 221
 222     BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
 223     BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
 224     CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 225     CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 226     CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 227     EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 228     EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
 229     FREETYPE_INCLUDE_DIR_freetype2  - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
 230     FREETYPE_INCLUDE_DIR_ft2build   - Only if building with Freetype2; directory that contains ft2build.h
 231     FREETYPE_LIBRARY                - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
 232     FREETYPE_DLL                    - Only if building with Freetype2 on Windows; path to libfreetype.dll
 233     GETTEXT_DLL                     - Only when building with Gettext on Windows; path to libintl3.dll
 234     GETTEXT_ICONV_DLL               - Only when building with Gettext on Windows; path to libiconv2.dll
 235     GETTEXT_INCLUDE_DIR             - Only when building with Gettext; directory that contains iconv.h
 236     GETTEXT_LIBRARY                 - Only when building with Gettext on Windows; path to libintl.dll.a
 237     GETTEXT_MSGFMT                  - Only when building with Gettext; path to msgfmt/msgfmt.exe
 238     IRRLICHT_DLL                    - Only on Windows; path to Irrlicht.dll
 239     IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h
 240     IRRLICHT_LIBRARY                - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
 241     LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 242     LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
 243     LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 244     PostgreSQL_INCLUDE_DIR          - Only when building with PostgreSQL; directory that contains libpq-fe.h
 245     POSTGRESQL_LIBRARY              - Only when building with PostgreSQL; path to libpq.a/libpq.so
 246     REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
 247     REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
 248     SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
 249     SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
 250     LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 251     LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 252     MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
 253     OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
 254     OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
 255     OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
 256     OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
 257     OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
 258     OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
 259     OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
 260     OPENGLES2_LIBRARY               - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
 261     SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
 262     SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
 263     VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
 264     VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 265     VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
 266     VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 267     VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 268     XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
 269     ZLIB_DLL                        - Only on Windows; path to zlib1.dll
 270     ZLIBWAPI_DLL                    - Only on Windows; path to zlibwapi.dll
 271     ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
 272     ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlibwapi.lib
 273
 274 ### Compiling on Windows
 275
 276 * This section is outdated. In addition to what is described here:
 277   * In addition to minetest, you need to download [minetest_game](https://github.com/minetest/minetest_game).
 278   * If you wish to have sound support, you need libogg, libvorbis and libopenal
 279
 280 * You need:
 281         * CMake:
 282                 http://www.cmake.org/cmake/resources/software.html
 283         * A compiler
 284                 * MinGW: http://www.mingw.org/
 285                 * or Visual Studio: http://msdn.microsoft.com/en-us/vstudio/default
 286         * Irrlicht SDK 1.7:
 287                 http://irrlicht.sourceforge.net/downloads.html
 288         * Zlib headers (zlib125.zip)
 289                 http://www.winimage.com/zLibDll/index.html
 290         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
 291                 http://www.winimage.com/zLibDll/index.html
 292         * SQLite3 headers and library
 293                 https://www.sqlite.org/download.html
 294         * Optional: gettext library and tools:
 295                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
 296                 * This is used for other UI languages. Feel free to leave it out.
 297         * And, of course, Minetest:
 298                 http://minetest.net/download
 299 * Steps:
 300         * Select a directory called DIR hereafter in which you will operate.
 301         * Make sure you have CMake and a compiler installed.
 302         * Download all the other stuff to DIR and extract them into there.
 303           ("extract here", not "extract to packagename/")
 304             * NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 305             * NOTE: You need to extract sqlite3.h & sqlite3ext.h from sqlite3 source
 306               and sqlite3.dll & sqlite3.def from sqlite3 precompiled binaries
 307               into "sqlite3" directory, and generate sqlite3.lib using command
 308               "LIB /DEF:sqlite3.def /OUT:sqlite3.lib"
 309         * All those packages contain a nice base directory in them, which
 310           should end up being the direct subdirectories of DIR.
 311         * You will end up with a directory structure like this (+=dir, -=file):
 312         -----------------
 313         + DIR
 314                 * zlib-1.2.5.tar.gz
 315                 * zlib125dll.zip
 316                 * irrlicht-1.8.3.zip
 317                 * sqlite-amalgamation-3130000.zip (SQLite3 headers)
 318                 * sqlite-dll-win32-x86-3130000.zip (SQLite3 library for 32bit system)
 319                 * 110214175330.zip (or whatever, this is the minetest source)
 320                 + zlib-1.2.5
 321                         * zlib.h
 322                         + win32
 323                         ...
 324                 + zlib125dll
 325                         * readme.txt
 326                         + dll32
 327                         ...
 328                 + irrlicht-1.8.3
 329                         + lib
 330                         + include
 331                         ...
 332                 + sqlite3
 333                         sqlite3.h
 334                         sqlite3ext.h
 335                         sqlite3.lib
 336                         sqlite3.dll
 337                 + gettext (optional)
 338                         +bin
 339                         +include
 340                         +lib
 341                 + minetest
 342                         + src
 343                         + doc
 344                         * CMakeLists.txt
 345                         ...
 346         -----------------
 347         * Start up the CMake GUI
 348         * Select "Browse Source..." and select DIR/minetest
 349         * Now, if using MSVC:
 350                 * Select "Browse Build..." and select DIR/minetest-build
 351         * Else if using MinGW:
 352                 * Select "Browse Build..." and select DIR/minetest
 353         * Select "Configure"
 354         * Select your compiler
 355         * It will warn about missing stuff, ignore that at this point. (later don't)
 356         * Make sure the configuration is as follows
 357           (note that the versions may differ for you):
 358
 359                 BUILD_CLIENT             [X]
 360                 BUILD_SERVER             [ ]
 361                 CMAKE_BUILD_TYPE         Release
 362                 CMAKE_INSTALL_PREFIX     DIR/minetest-install
 363                 IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.8.3
 364                 RUN_IN_PLACE             [X]
 365                 WARN_ALL                 [ ]
 366                 ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 367                 ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 368                 ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 369                 GETTEXT_BIN_DIR          DIR/gettext/bin
 370                 GETTEXT_INCLUDE_DIR      DIR/gettext/include
 371                 GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 372                 GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 373
 374         * If CMake complains it couldn't find SQLITE3, choose "Advanced" box on the
 375           right top corner, then specify the location of SQLITE3_INCLUDE_DIR and
 376           SQLITE3_LIBRARY manually.
 377         * If you want to build 64-bit minetest, you will need to build 64-bit version
 378           of irrlicht engine manually, as only 32-bit pre-built library is provided.
 379         * Hit "Configure"
 380         * Hit "Configure" once again 8)
 381         * If something is still coloured red, you have a problem.
 382         * Hit "Generate"
 383         If using MSVC:
 384                 * Open the generated minetest.sln
 385                 * The project defaults to the "Debug" configuration. Make very sure to
 386                   select "Release", unless you want to debug some stuff (it's slower
 387                   and might not even work at all)
 388                 * Build the ALL_BUILD project
 389                 * Build the INSTALL project
 390                 * You should now have a working game with the executable in
 391                         DIR/minetest-install/bin/minetest.exe
 392                 * Additionally you may create a zip package by building the PACKAGE
 393                   project.
 394         If using MinGW:
 395                 * Using the command line, browse to the build directory and run 'make'
 396                   (or mingw32-make or whatever it happens to be)
 397                 * You may need to copy some of the downloaded DLLs into bin/, see what
 398                   running the produced executable tells you it doesn't have.
 399                 * You should now have a working game with the executable in
 400                         DIR/minetest/bin/minetest.exe
 401
 402 ### Bat script to build Windows releases of Minetest
 403
 404 This is how we build Windows releases.
 405
 406     set sourcedir=%CD%
 407     set installpath="C:\tmp\minetest_install"
 408     set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 409
 410     set builddir=%sourcedir%\bvc10
 411     mkdir %builddir%
 412     pushd %builddir%
 413     cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
 414     if %errorlevel% neq 0 goto fail
 415     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 416     if %errorlevel% neq 0 goto fail
 417     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 418     if %errorlevel% neq 0 goto fail
 419     "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 420     if %errorlevel% neq 0 goto fail
 421     popd
 422     echo Finished.
 423     exit /b 0
 424
 425     :fail
 426     popd
 427     echo Failed.
 428     exit /b 1
 429
 430 Version scheme
 431 --------------
 432 We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
 433
 434 - Major is incremented when the release contains breaking changes, all other
 435 numbers are set to 0.
 436 - Minor is incremented when the release contains new non-breaking features,
 437 patch is set to 0.
 438 - Patch is incremented when the release only contains bugfixes and very
 439 minor/trivial features considered necessary.
 440
 441 Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
 442 ie: 5.0.0-dev is the development version leading to 5.0.0.
 443 Prior to that we used `previous_version-dev`.