Replace libgl-dev by libgl1-mesa-dev

[dragonblocks_alpha.git] / README.md

diff --git a/README.md b/README.md
index c5472422a082687abc972ebf3189dabab33f2f60..5a14615846f3fc364209efa3f40be2cc1d76f25c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,30 @@
 # Dragonblocks Alpha
 
 A multiplayer voxelgame for POSIX systems.
+It has been ported to Linux, Windows, FreeBSD and OpenBSD, but may work on other systems.
 
-Head to <https://www.elidragon.com/dragonblocks_alpha/> for ubuntu snapshot and release builds.
+Head to <https://www.elidragon.tk/dragonblocks_alpha/> for snapshot and release builds (CURRENTLY DOWN).
 
 ## Invocation
 
-```bash
-./DragonblocksServer <port>
-./Dragonblocks <address> <port>
+```sh
+# on posix
+./dragonblocks_server "<address>:<port>"
+./dragonblocks_client "<address>:<port>"
+
+# on windows
+dragonblocks_server.exe "<address>:<port>"
+dragonblocks_client.exe "<address>:<port>"
 ```
 
 or alternatively:
 
-```bash
+```sh
+# on posix
 ./singleplayer.sh
+
+# on windows
+singleplayer.bat
 ```
 
 ## Controls
@@ -35,44 +45,26 @@ or alternatively:
 | F11 | Toggle fullscreen |
 | ESC | Pause / unpause game |
 
-## Dependencies
-
-The client depends on GLFW3, OpenGL, GLEW and Freetype.
-
-```bash
-sudo apt install libgl1-mesa-dri libglfw3 libglew2.1 libfreetype6
-```
-
-The server depends on SQLite3.
-
-```bash
-sudo apt install libsqlite3-0
-```
-
-both the client and the server depend on ZLib.
-
-```bash
-sudo apt install zlib1g
-```
-
-## Setup Requirements
+## System 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.
+The minimum OpenGL version is 4.2.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 necessarily required.
 
 ## Current Features
-- Multiplayer
-- Map generation with mountains, snow, temperature and humidity, dynamic grass color, oceans and beaches, vulcanos
+- Multiplayer, Animated player model, Nametags
+- Mountains, snow, temperature and humidity, dynamic grass color, oceans and beaches, vulcanos, boulders
 - Physics
 - FPS Camera
-- Mipmapping, Antialiasing, Face Culling, Diffuse Lighting, Skybox, Fog
+- 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
+- Saving terrain, player positions and other data to a SQLite3 database
+- Multithreaded terrain generation, mesh generation and networking
 - Handlers for SIGINT und SIGTERM (just Ctrl+C to shut down the server)
+- Log levels: error, warning, access, action, info, verbose
+- Loading assets such as textures, models, schematics, shaders and fonts from files
 
 ## Usage