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