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