Use spaces for alignment

[dragonblocks_alpha.git] / README.md

diff --git a/README.md b/README.md
index 11e8b5e566a896596648b41933ed044694ec501e..e3ff937a8864ecc7f73b171f908166a301e1851a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 A multiplayer voxelgame for POSIX systems.
 
-Head to <https://www.elidragon.com/dragonblocks_alpha/> for snapshot and release builds.
+Head to <https://www.elidragon.com/dragonblocks_alpha/> for ubuntu snapshot and release builds.
 
 ## Invocation
 
@@ -29,39 +29,54 @@ or alternatively:
 | Left Shift | When flying: Move Down |
 | F | Toggle flight |
 | C | Toggle collision |
-| F11 | Toggle fullscreen |
+| T | Toggle timelapse |
+| F2 | Take screenshot |
 | F3 | Toggle debug info |
+| F11 | Toggle fullscreen |
 | ESC | Pause / unpause game |
 
 ## Dependencies
 
+Both the client and the server depend on ZLib.
 The client depends on GLFW3, OpenGL, GLEW and Freetype.
+The server depends on SQLite3.
+
+Ubuntu / Debian:
 
 ```bash
-sudo apt install libgl1-mesa-dri libglfw3 libglew2.1 libfreetype6
+sudo apt install zlib1g libgl1-mesa-dri libglfw3 libglew2.1 libfreetype6 libsqlite3-0
+
 ```
 
-The server depends on SQLite3.
+FreeBSD:
 
-```bash
-sudo apt install libsqlite3-0
+```csh
+sudo pkg install lzlib mesa-dri glfw glew freetype sqlite3
 ```
 
-both the client and the server depend on ZLib.
+OpenBSD:
 
-```bash
-sudo apt install zlib1g
+```sh
+sudo pkg_add lzlib glfw glew freetype sqlite3
 ```
 
+## Setup Requirements
+Dragonblocks Alpha targets PCs only. Non x86-64 platforms may work, however there is no guarantee whatsoever.
+You need a POSIX system conforming to the ISO C and POSIX 2008 standards. However, so far only GNU/Linux systems, in particular Ubuntu and Debian, have been tested.
+The minimum OpenGL version is 4.6.0. Dragonblocks has been tested on Intel Integrated and NVIDIA GPUs, however other graphics cards should work as well.
+A PC with at least 4 CPU cores is recommended, but not necessarly required.
+
 ## Current Features
 - Multiplayer
-- Map generation with mountains and blended biomes that determine grass color
+- Mountains, snow, temperature and humidity, dynamic grass color, oceans and beaches, vulcanos, boulders
 - Physics
 - FPS Camera
-- Mipmapping, Antialiasing, Shaders
-- HUD
-- Saving the map to a SQLite3 database
-- Multithreading for map generation, mesh generation and network
+- Mipmapping, Antialiasing, Face Culling, Frustum Culling, Diffuse Lighting, Skybox, Fog
+- Taking screenshots
+- Daylight cycle
+- GUI
+- Saving map, player positions and other data to a SQLite3 database
+- Multithreaded map generation, mesh generation and networking
 - Handlers for SIGINT und SIGTERM (just Ctrl+C to shut down the server)
 
 ## Usage
@@ -94,10 +109,10 @@ The name "Dragonblocks _Alpha_" does not have anything to do with the game being
 - Exciting and feature-rich gameplay with the focus on exploring and adventuring, while still being multi-optional and not too bloated
 - A simple structure and invocation syntax
 - Using modern OpenGL to combine performance with graphics quality on high-end computers
-- Portability between PCs running POSIX systems (various Linux Distributions, BSD, MacOS, Plan 9)
+- Portability between PCs running POSIX systems (focus: Linux, BSD, MacOS, Plan 9 APE, Windows MinGW)
 
 ### What Dragonblocks Alpha does not aim to achieve
-- Portability to Windows or Phones / Consoles
+- Portability to Phones / Consoles
 - Good performance on low-end PCs
 - A fixed story or lore
 - Cloning Minecraft behavior