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