Dungeongen: Optionally set ignore to be untouchable to disable floating dungeons
[oweals/minetest.git] / README.txt
index 927fdad1110f73a1ff31ec14e0f4860e21cc76e6..a3aa9e6b3fabf4debc837979551737c9899053a4 100644 (file)
@@ -103,18 +103,30 @@ Compiling on GNU/Linux:
 -----------------------
 
 Install dependencies. Here's an example for Debian/Ubuntu:
-$ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev
+$ sudo apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libjsoncpp-dev
 
-Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
-$ wget https://github.com/minetest/minetest/tarball/master -O master.tar.gz
+You can install git for easily keeping your copy up to date.
+If you dont want git, read below on how to get the source without git.
+This is an example for installing git on Debian/Ubuntu:
+$ sudo apt-get install git-core
+
+Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
+$ git clone --depth 1 https://github.com/minetest/minetest.git
+$ cd minetest
+
+Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
+$ git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
+
+Download source, without using git:
+$ wget https://github.com/minetest/minetest/archive/master.tar.gz
 $ tar xf master.tar.gz
-$ cd minetest-minetest-286edd4 (or similar)
+$ cd minetest-master
 
-Download minetest_game (otherwise only the "Minimal development test" game is available)
+Download minetest_game, without using git:
 $ cd games/
-$ wget https://github.com/minetest/minetest_game/tarball/master -O minetest_game.tar.gz
-$ tar xf minetest_game.tar.gz
-$ mv minetest-minetest_game-* minetest_game
+$ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
+$ tar xf master.tar.gz
+$ mv minetest_game-master minetest_game
 $ cd ..
 
 Build a version that runs directly from the source directory:
@@ -122,8 +134,7 @@ $ cmake . -DRUN_IN_PLACE=1
 $ make -j2
 
 Run it:
-$ cd bin
-$ ./minetest
+$ ./bin/minetest
 
 - Use cmake . -LH to see all CMake options and their current state
 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
@@ -167,6 +178,7 @@ EGL_egl_LIBRARY                 - Only if building with GLES; path to libEGL.a/l
 FREETYPE_INCLUDE_DIR_freetype2  - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
 FREETYPE_INCLUDE_DIR_ft2build   - Only if building with Freetype2; directory that contains ft2build.h
 FREETYPE_LIBRARY                - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
+FREETYPE_DLL                    - Only if building with Freetype2 on Windows; path to libfreetype.dll
 GETTEXT_DLL                     - Only when building with Gettext on Windows; path to libintl3.dll
 GETTEXT_ICONV_DLL               - Only when building with Gettext on Windows; path to libiconv2.dll
 GETTEXT_INCLUDE_DIR             - Only when building with Gettext; directory that contains iconv.h
@@ -176,7 +188,8 @@ IRRLICHT_DLL                    - path to Irrlicht.dll
 IRRLICHT_INCLUDE_DIR            - directory that contains IrrCompileConfig.h
 IRRLICHT_LIBRARY                - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
 LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
-LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll
+LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
+LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
 REDIS_INCLUDE_DIR               - Only when building with redis support; directory that contains hiredis.h
 REDIS_LIBRARY                   - Only when building with redis support; path to libhiredis.a/libhiredis.so
 LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
@@ -198,7 +211,8 @@ VORBIS_DLL                      - Only if building with sound on Windows; path t
 VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
-ZLIB_DLL                        - Only on Windows; path to zlibwapi.dll
+ZLIB_DLL                        - Only on Windows; path to zlib1.dll
+ZLIBWAPI_DLL                    - Only on Windows; path to zlibwapi.dll
 ZLIB_INCLUDE_DIR                - directory where zlib.h is located
 ZLIB_LIBRARY                    - path to libz.a/libz.so/zlibwapi.lib
 
@@ -224,7 +238,7 @@ Compiling on Windows:
                http://gnuwin32.sourceforge.net/downlinks/gettext.php
                - This is used for other UI languages. Feel free to leave it out.
        * And, of course, Minetest:
-               http://minetest.net/download.php
+               http://minetest.net/download
 - Steps:
        - Select a directory called DIR hereafter in which you will operate.
        - Make sure you have CMake and a compiler installed.