doc/running

   1 Dependencies
   2 ============
   3
   4         GLEW, GLM, SDL2, SDL2_image, SDL2_net, SDL2_ttf, OpenAL, freealut, zlib
   5
   6 archlinux:
   7         pacman -S glew glm sdl2 sdl2_image sdl2_net sdl2_ttf openal freealut zlib
   8
   9 debian (jessie):
  10         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
  11
  12 centos (7):
  13         yum install glew SDL2 SDL2_image SDL2_net SDL2_ttf openal-soft freealut zlib
  14
  15 Arguments
  16 =========
  17
  18 Runtime
  19 -------
  20
  21 -n <n>
  22         terminate after <n> frames
  23
  24 -t <t>
  25         terminate after <t> milliseconds
  26
  27 if both n and t are given, terminate after n frames and
  28 assume <t> milliseconds pass each frame
  29
  30 --asset-path <path>
  31         load assets from given path
  32         default is application dir + "assets"
  33
  34 --save-path <path>
  35         store and load saves at given path
  36         default is whatever SDL thinks is good
  37         (should be ~/.local/share/localhorst/blank/)
  38
  39 Application
  40 -----------
  41
  42 -d
  43         disable double buffering
  44
  45 -m <num>
  46         set sample size to <num> (samples per pixel)
  47
  48 --no-vsync
  49         disable vsync
  50
  51 --standalone
  52         run as standalone (the default)
  53
  54 --client
  55         run as client
  56
  57 --server
  58         run as server
  59
  60 Interface
  61 ---------
  62
  63 --no-keyboard
  64         disable keyboard input handling
  65
  66 --no-mouse
  67         disable mouse input handling
  68
  69 --no-hud
  70         disable HUD drawing (includes the selected block outline)
  71
  72 --no-audio
  73         disable audio
  74         the audio device and sounds will still be allocated
  75         it just stops the interface from queueing buffers
  76
  77 Network
  78 -------
  79
  80 --host <hostname>
  81         hostname to connect to in client mode
  82
  83 --port <number>
  84         port number to connection to (client) or listen on (server)
  85
  86 --player-name <name>
  87         use given name to identify with the server (client mode)
  88         default player name is "default"
  89         the server will reject players with names that are already taken
  90
  91 World
  92 -----
  93
  94 -s <seed>
  95         use <seed> (unsigned integer) as the world seed
  96         only used for newly created worlds
  97         default is 0
  98
  99 --world-name <name>
 100         use given name for the world save
 101         no checks are being done right now, so make sure it can be
 102         used as a directory name
 103
 104
 105 Controls
 106 ========
 107
 108 Move around with WSAD, shift, and space, look around with mouse motion.
 109 Mouse button 1 deletes the block you're pointing at, button 2 selects it
 110 as the active block, and button 3 places the active block next to the one
 111 you're pointing at.
 112
 113 As an alternative to picking, you can also use the mousewheel up/down to
 114 flip through available blocks or access the first 10 via the number keys.
 115
 116 F1 toggles UI rendering.
 117 F2 toggles world rendering.
 118 F3 toggles the debug overlay.
 119 F4 toggles audio.
 120 F5 toggles camera mode.
 121
 122 Controls are interpreted by scancode, meaning you don't have to break your
 123 fingers when you're on an AZERTY. WSAD will be ZSQD there and the above
 124 description is just wrong.
 125
 126 Also I've added a plethora of alternate keys that can be used, like arrow
 127 keys for movement, ins/del for placing/removing blocks, etc.