map.cpp: Initialize NodeNeighbor, set NeighborType to u8 & cleanup
[oweals/minetest.git] / README.md
index 8c8331774f5f5172f8ae9a98e09ab887fdd1bba4..2544b40407a74e95068b50fcaeccaba77fea1c6c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Minetest
 
 An InfiniMiner/Minecraft inspired game.
 
-Copyright (c) 2010-2017 Perttu Ahola <celeron55@gmail.com>
+Copyright (c) 2010-2018 Perttu Ahola <celeron55@gmail.com>
 and contributors (see source file comments and the version control log)
 
 In case you downloaded the source code:
@@ -32,46 +32,46 @@ This game is not finished
 
 Default controls
 ----------------
-
 All controls are re-bindable using settings.
 Some can be changes in the key config dialog in the settings tab.
 
-- Move mouse: Look around
-- W, A, S, D: Move
-- Space: Jump/move up
-- Shift: Sneak/move down
-- Q: Drop itemstack
-- Shift + Q: Drop single item
-- Left mouse button: Dig/punch/take item
-- Right mouse button: Place/use
-- Shift + right mouse button: Build (without using)
-- I: Inventory menu
-- Mouse wheel: Select item
-- 0-9: Select item
-- Z: Zoom (needs zoom privilege)
-- T: Chat
-- /: Command
-- Esc: Pause menu/abort/exit (pauses only singleplayer game)
-- R: Enable/disable full range view
-- +: Increase view range
-- -: Decrease view range
-- K: Enable/disable fly mode (needs fly privilege)
-- J: Enable/disable fast mode (needs fast privilege)
-- H: Enable/disable noclip mode (needs noclip privilege)
-- E: Move fast in fast mode
-- F1:  Hide/show HUD
-- F2:  Hide/show chat
-- F3:  Disable/enable fog
-- F4:  Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)
-- F5:  Cycle through debug info screens
-- F6:  Cycle through profiler info screens
-- F7:  Cycle through camera modes
-- F8:  Toggle cinematic mode
-- F9:  Cycle through minimap modes
-- Shift + F9: Change minimap orientation
-- F10: Show/hide console
-- F12: Take screenshot
-- P: Write stack traces into debug.txt
+| Button                        | Action                                                         |
+|-------------------------------|----------------------------------------------------------------|
+| Move mouse                    | Look around                                                    |
+| W, A, S, D                    | Move                                                           |
+| Space                         | Jump/move up                                                   |
+| Shift                         | Sneak/move down                                                |
+| Q                             | Drop itemstack                                                 |
+| Shift + Q                     | Drop single item                                               |
+| Left mouse button             | Dig/punch/take item                                            |
+| Right mouse button            | Place/use                                                      |
+| Shift + right mouse button    | Build (without using)                                          |
+| I                             | Inventory menu                                                 |
+| Mouse wheel                   | Select item                                                    |
+| 0-9                           | Select item                                                    |
+| Z                             | Zoom (needs zoom privilege)                                    |
+| T                             | Chat                                                           |
+| /                             | Command                                                        |
+| Esc                           | Pause menu/abort/exit (pauses only singleplayer game)          |
+| R                             | Enable/disable full range view                                 |
+| +                             | Increase view range                                            |
+| -                             | Decrease view range                                            |
+| K                             | Enable/disable fly mode (needs fly privilege)                  |
+| J                             | Enable/disable fast mode (needs fast privilege)                |
+| H                             | Enable/disable noclip mode (needs noclip privilege)            |
+| E                             | Move fast in fast mode                                         |
+| F1                            |  Hide/show HUD                                                 |
+| F2                            |  Hide/show chat                                                |
+| F3                            |  Disable/enable fog                                            |
+| F4                            |  Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)  |
+| F5                            |  Cycle through debug info screens                              |
+| F6                            |  Cycle through profiler info screens                           |
+| F7                            |  Cycle through camera modes                                    |
+| F8                            |  Toggle cinematic mode                                         |
+| F9                            |  Cycle through minimap modes                                   |
+| Shift + F9                    | Change minimap orientation                                     |
+| F10                           | Show/hide console                                              |
+| F12                           | Take screenshot                                                |
 
 Paths
 -----
@@ -118,7 +118,19 @@ Compiling
 
 ### Compiling on GNU/Linux
 
-Install dependencies. Here's an example for Debian/Ubuntu:
+#### Dependencies
+
+| Dependency | Version | Commentary |
+|------------|---------|------------|
+| GCC        | 4.9+    | Can be replaced with Clang 3.4+ |
+| CMake      | 2.6+    |            |
+| Irrlicht   | 1.7.3+  |            |
+| SQLite3    | 3.0+    |            |
+| LuaJIT     | 2.0+    | Bundled Lua 5.1 is used if not present |
+| GMP        | 5.0.0+  | Bundled mini-GMP is used if not present |
+| JsonCPP    | 1.0.0+  | Bundled JsonCPP is used if not present |
+
+For Debian/Ubuntu:
 
     $ 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
 
@@ -126,6 +138,8 @@ 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-devel bzip2-devel
 
+#### Download
+
 You can install git for easily keeping your copy up to date.
 If you don’t want git, read below on how to get the source without git.  
 This is an example for installing git on Debian/Ubuntu:
@@ -159,6 +173,8 @@ Download minetest_game, without using git:
     $ mv minetest_game-master minetest_game
     $ cd ..
 
+#### Build
+
 Build a version that runs directly from the source directory:
 
     $ cmake . -DRUN_IN_PLACE=TRUE