Set acceleration only once in falling node

[minetest.git] / README.txt

diff --git a/README.txt b/README.txt
index 70ad53e95413bd62cdb39c3631ba796041398235..c62143ff34750d5c384de18bbef04f0cc176a0d0 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,24 +1,25 @@
-Minetest-c55
-============
+Minetest
+========

 
 An InfiniMiner/Minecraft inspired game.
 
 
 An InfiniMiner/Minecraft inspired game.
 

-Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
-and ther contributors (see source file comments and the version control log)
+Copyright (c) 2010-2013 Perttu Ahola <celeron55@gmail.com>
+and contributors (see source file comments and the version control log)

 
 In case you downloaded the source code:
 ---------------------------------------
 If you downloaded the Minetest Engine source code in which this file is
 contained, you probably want to download the minetest_game project too:
 
 In case you downloaded the source code:
 ---------------------------------------
 If you downloaded the Minetest Engine source code in which this file is
 contained, you probably want to download the minetest_game project too:

-  https://github.com/celeron55/minetest_game/
+  https://github.com/minetest/minetest_game/

 See the README.txt in it.
 
 Further documentation
 ----------------------
 See the README.txt in it.
 
 Further documentation
 ----------------------

-- Website: http://c55.me/minetest/
-- Wiki: http://c55.me/minetest/wiki/
-- Forum: http://c55.me/minetest/forum/
-- Github: https://github.com/celeron55/minetest/
+- Website: http://minetest.net/
+- Wiki: http://wiki.minetest.net/
+- Developer wiki: http://dev.minetest.net/
+- Forum: http://forum.minetest.net/
+- Github: https://github.com/minetest/minetest/

 - doc/ directory of source distribution
 
 This game is not finished
 - doc/ directory of source distribution
 
 This game is not finished


@@ -28,19 +29,42 @@ This game is not finished
 
 Default Controls
 -----------------
 
 Default Controls
 -----------------

-- WASD: Move
-- Space: Jump
-- E: Go down
-- Shift: Sneak
-- Q: Drop item
-- I: Open inventory
-- Mouse: Turn/look
+- WASD: move
+- Space: jump/climb
+- Shift: sneak/go down
+- Q: drop itemstack (+ SHIFT for single item)
+- I: inventory
+- Mouse: turn/look
+- Mouse left: dig/punch
+- Mouse right: place/use
+- Mouse wheel: select item
+- T: chat
+- 1-8: select item
+
+- Esc: pause menu (pauses only singleplayer game)
+- R: Enable/Disable full range view
+- +: Increase view range
+- -: Decrease view range
+- K: Enable/Disable fly (needs fly privilege)
+- J: Enable/Disable fast (needs fast privilege)
+- H: Enable/Disable noclip (needs noclip privilege)
+
+- F1:  Hide/Show HUD
+- F2:  Hide/Show Chat
+- F3:  Disable/Enable Fog
+- F4:  Disable/Enable Camera update (Mapblocks are not updated anymore when disabled)
+- F5:  Toogle through debug info screens
+- F6:  Toogle through output data
+- F7:  Toggle through camera modes
+- F10: Show/Hide console
+- F12: Take screenshot
+

 - Settable in the configuration file, see the section below.
 
 Paths
 ------
 $bin   - Compiled binaries
 - Settable in the configuration file, see the section below.
 
 Paths
 ------
 $bin   - Compiled binaries

-$share - Cistributed read-only data
+$share - Distributed read-only data

 $user  - User-created modifiable data
 
 Windows .zip / RUN_IN_PLACE source:
 $user  - User-created modifiable data
 
 Windows .zip / RUN_IN_PLACE source:


@@ -54,9 +78,9 @@ $share = /usr/share/minetest
 $user  = ~/.minetest
 
 OS X:
 $user  = ~/.minetest
 
 OS X:

-$bin   = ?
-$share = ?
-$user  = ~/Library/Application Support/minetest
+$bin   = Contents/MacOS
+$share = Contents/Resources
+$user  = Contents/User OR ~/Library/Application Support/minetest

 
 World directory
 ----------------
 
 World directory
 ----------------


@@ -79,33 +103,133 @@ Compiling on GNU/Linux:
 -----------------------
 
 Install dependencies. Here's an example for Debian/Ubuntu:
 -----------------------
 
 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
+$ sudo apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-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
+
+For Fedora users:
+$ 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-dev bzip2-dev
+
+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
+
+For Fedora users:
+$ sudo dnf install git-core

 
 

-Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
-$ wget https://github.com/celeron55/minetest/tarball/master -O master.tar.gz
+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
 $ tar xf master.tar.gz

-$ cd celeron55-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/
 $ cd games/

-$ wget https://github.com/celeron55/minetest_game/tarball/master -O master.tar.gz
+$ wget https://github.com/minetest/minetest_game/archive/master.tar.gz

 $ tar xf master.tar.gz
 $ tar xf master.tar.gz

-$ mv celeron55-minetest_game-* minetest_game
+$ mv minetest_game-master minetest_game

 $ cd ..
 
 Build a version that runs directly from the source directory:
 $ cd ..
 
 Build a version that runs directly from the source directory:

-$ cmake . -DRUN_IN_PLACE=1
-$ make -j2
+$ cmake . -DRUN_IN_PLACE=TRUE
+$ make -j <number of processors>

 
 Run it:
 
 Run it:

-$ cd bin
-$ ./minetest
+$ ./bin/minetest

 
 - Use cmake . -LH to see all CMake options and their current state
 
 - 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
-- You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
+- If you want to install it system-wide (or are making a distribution package),
+  you will want to use -DRUN_IN_PLACE=FALSE
+- You can build a bare server by specifying -DBUILD_SERVER=TRUE
+- You can disable the client build by specifying -DBUILD_CLIENT=FALSE

 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
   - Debug build is slower, but gives much more useful output in a debugger
 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
   - Debug build is slower, but gives much more useful output in a debugger

+- If you build a bare server, you don't need to have Irrlicht installed.
+  In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
+
+CMake options
+-------------
+General options:
+
+BUILD_CLIENT        - Build Minetest client
+BUILD_SERVER        - Build Minetest server
+CMAKE_BUILD_TYPE    - Type of build (Release vs. Debug)
+    Release         - Release build
+    Debug           - Debug build
+    SemiDebug       - Partially optimized debug build
+    RelWithDebInfo  - Release build with Debug information
+    MinSizeRel      - Release build with -Os passed to compiler to make executable as small as possible
+ENABLE_CURL         - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
+ENABLE_CURSES       - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
+ENABLE_FREETYPE     - Build with FreeType2; Allows using TTF fonts
+ENABLE_GETTEXT      - Build with Gettext; Allows using translations
+ENABLE_GLES         - Search for Open GLES headers & libraries and use them
+ENABLE_LEVELDB      - Build with LevelDB; Enables use of LevelDB map backend (faster than SQLite3)
+ENABLE_REDIS        - Build with libhiredis; Enables use of Redis map backend
+ENABLE_SPATIAL      - Build with LibSpatial; Speeds up AreaStores
+ENABLE_SOUND        - Build with OpenAL, libogg & libvorbis; in-game Sounds
+ENABLE_LUAJIT       - Build with LuaJIT (much faster than non-JIT Lua)
+ENABLE_SYSTEM_GMP   - Use GMP from system (much faster than bundled mini-gmp)
+RUN_IN_PLACE        - Create a portable install (worlds, settings etc. in current directory)
+USE_GPROF           - Enable profiling using GProf
+VERSION_EXTRA       - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
+
+Library specific options:
+
+BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
+BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
+CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
+CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
+CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
+EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
+EGL_LIBRARY                     - Only if building with GLES; path to libEGL.a/libEGL.so
+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
+GETTEXT_LIBRARY                 - Only when building with Gettext on Windows; path to libintl.dll.a
+GETTEXT_MSGFMT                  - Only when building with Gettext; path to msgfmt/msgfmt.exe
+IRRLICHT_DLL                    - Only on Windows; path to Irrlicht.dll
+IRRLICHT_INCLUDE_DIR            - Directory that contains IrrCompileConfig.h
+IRRLICHT_LIBRARY                - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
+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.a
+LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
+REDIS_INCLUDE_DIR               - Only when building with Redis; directory that contains hiredis.h
+REDIS_LIBRARY                   - Only when building with Redis; path to libhiredis.a/libhiredis.so
+SPATIAL_INCLUDE_DIR             - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
+SPATIAL_LIBRARY                 - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
+LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
+LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
+MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
+OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
+OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
+OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
+OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
+OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
+OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
+OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
+OPENGLES2_LIBRARY               - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
+SQLITE3_INCLUDE_DIR             - Directory that contains sqlite3.h
+SQLITE3_LIBRARY                 - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
+VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
+VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
+VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
+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 zlib1.dll
+ZLIBWAPI_DLL                    - Only on Windows; path to zlibwapi.dll
+ZLIB_INCLUDE_DIR                - Directory that contains zlib.h
+ZLIB_LIBRARY                    - Path to libz.a/libz.so/zlibwapi.lib

 
 Compiling on Windows:
 ---------------------
 
 Compiling on Windows:
 ---------------------


@@ -125,11 +249,11 @@ Compiling on Windows:
                http://www.winimage.com/zLibDll/index.html
        * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
                http://www.winimage.com/zLibDll/index.html
                http://www.winimage.com/zLibDll/index.html
        * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
                http://www.winimage.com/zLibDll/index.html

-       * Optional: gettext bibrary and tools:
+       * Optional: gettext library and tools:

                http://gnuwin32.sourceforge.net/downlinks/gettext.php
                - This is used for other UI languages. Feel free to leave it out.
                http://gnuwin32.sourceforge.net/downlinks/gettext.php
                - This is used for other UI languages. Feel free to leave it out.

-       * And, of course, Minetest-c55:
-               http://c55.me/minetest/download
+       * And, of course, Minetest:
+               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.
 - Steps:
        - Select a directory called DIR hereafter in which you will operate.
        - Make sure you have CMake and a compiler installed.


@@ -227,7 +351,7 @@ set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 set builddir=%sourcedir%\bvc10
 mkdir %builddir%
 pushd %builddir%
 set builddir=%sourcedir%\bvc10
 mkdir %builddir%
 pushd %builddir%

-cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
+cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%

 if %errorlevel% neq 0 goto fail
 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 if %errorlevel% neq 0 goto fail
 if %errorlevel% neq 0 goto fail
 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 if %errorlevel% neq 0 goto fail


@@ -244,32 +368,46 @@ popd
 echo Failed.
 exit /b 1
 
 echo Failed.
 exit /b 1
 

-License of Minetest-c55 textures and sounds
--------------------------------------------
+License of Minetest textures and sounds
+---------------------------------------

 
 This applies to textures and sounds contained in the main Minetest
 distribution.
 
 
 This applies to textures and sounds contained in the main Minetest
 distribution.
 

-Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)                                 
+Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)

 http://creativecommons.org/licenses/by-sa/3.0/
 
 http://creativecommons.org/licenses/by-sa/3.0/
 

-License of Minetest-c55 source code
------------------------------------
+Authors of media files
+-----------------------
+Everything not listed in here:
+Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
+
+BlockMen:
+  textures/base/pack/menuheader.png
+
+erlehmann:
+  misc/minetest-icon-24x24.png
+  misc/minetest-icon.ico
+  misc/minetest.svg
+  textures/base/pack/logo.png

 
 

-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+License of Minetest source code
+-------------------------------
+
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>

 
 This program is free software; you can redistribute it and/or modify
 
 This program is free software; you can redistribute it and/or modify

-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or

 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

-GNU General Public License for more details.
+GNU Lesser General Public License for more details.

 
 

-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along

 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 


@@ -362,13 +500,31 @@ DejaVu Sans Mono:
   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 
   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 

-  Bitstream Vera Fonts Copyright:
+Bitstream Vera Fonts Copyright:

 
   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
   a trademark of Bitstream, Inc.
 
 
   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
   a trademark of Bitstream, Inc.
 

-  Arev Fonts Copyright:
+Arev Fonts Copyright:

 
   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 
 
   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 

+Liberation Fonts Copyright:
+
+  Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
+
+DroidSansFallback:
+
+  Copyright (C) 2008 The Android Open Source Project
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0

 
 

+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.