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