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