]> git.lizzy.rs Git - dragonblocks_alpha.git/blob - README.md
Document singleplayer script in README.md
[dragonblocks_alpha.git] / README.md
1 # Dragonblocks alpha
2
3 ## Usage
4 ```bash
5 ./DragonblocksServer <port>
6 ./Dragonblocks <address> <port>
7 ```
8
9 or alternatively:
10
11 ```bash
12 ./singleplayer.sh
13 ```
14
15 The server will save the map to a file named "map" in the directory it is run in. It will also load the map from there at startup, given that the file exists.
16
17 ## Nodes:
18 - `unloaded`: used for nodes in unloaded mapblocks
19 - `air`: default node in newly generated mapblocks
20 - `dirt`
21 - `grass`
22 - `stone`
23 - `invalid`: unknown nodes received from server
24
25 Interrupt handlers for SIGINT und SIGTERM are implemented.
26
27 ## Dependencies
28
29 The client depends on GLFW3, OpenGL and GLEW.
30 ```bash
31 sudo apt install libgl1-mesa-dri libglfw3 libglew2.1
32 ```