add TCP based CLI

[blank.git] / doc / running

diff --git a/doc/running b/doc/running
index 846f27d8ba389f8f98ca7062d03c9ea4245c355b..426c46324f5ee7f34705b51a61fcc0e8ad0f9c6c 100644 (file)
--- a/doc/running
+++ b/doc/running
@@ -1,3 +1,21 @@
+Dependencies
+============
+
+       GLEW, GLM, SDL2, SDL2_image, SDL2_net, SDL2_ttf, OpenAL, freealut, zlib
+
+archlinux:
+       pacman -S \
+               glew glm sdl2 sdl2_image sdl2_net sdl2_ttf openal freealut zlib
+
+debian:
+       apt install --no-install-recommends \
+               libglew1.10 libglu1-mesa libsdl2-2.0-0 libsdl2-image-2.0-0 \
+               libsdl2-net-2.0-0 libsdl2-ttf-2.0-0 libopenal1 libalut0 zlib1g
+
+centos:
+       yum install \
+               glew SDL2 SDL2_image SDL2_net SDL2_ttf openal-soft freealut zlib
+

 Arguments
 =========
 
 Arguments
 =========
 


@@ -69,6 +87,10 @@ Network
 --port <number>
        port number to connection to (client) or listen on (server)
 
 --port <number>
        port number to connection to (client) or listen on (server)
 

+--cmd-port <number>
+       port number to listen on for command connections
+       the default of 0 disables this feature
+

 --player-name <name>
        use given name to identify with the server (client mode)
        default player name is "default"
 --player-name <name>
        use given name to identify with the server (client mode)
        default player name is "default"


@@ -97,16 +119,13 @@ as the active block, and button 3 places the active block next to the one
 you're pointing at.
 
 As an alternative to picking, you can also use the mousewheel up/down to
 you're pointing at.
 
 As an alternative to picking, you can also use the mousewheel up/down to

-flip through available blocks.
-
-Q changes the face of the active block (loops over up, down, right, left,
-front, and back) and E changes the turn (none, left, around, and right).
-
-Press N to toggle player/world collision.
+flip through available blocks or access the first 10 via the number keys.

 
 F1 toggles UI rendering.
 
 F1 toggles UI rendering.

-F3 toggles a display telling how long on average it takes to compute a frame.
+F2 toggles world rendering.
+F3 toggles the debug overlay.

 F4 toggles audio.
 F4 toggles audio.

+F5 toggles camera mode.

 
 Controls are interpreted by scancode, meaning you don't have to break your
 fingers when you're on an AZERTY. WSAD will be ZSQD there and the above
 
 Controls are interpreted by scancode, meaning you don't have to break your
 fingers when you're on an AZERTY. WSAD will be ZSQD there and the above