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