1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="style.css">
<TITLE>The Osirion Project - User manual</TITLE>
</head>
<body>
<H1>
The Osirion Project - User manual
</H1>
<h2>
Client
</h2>
<p>
Starting the client will show the loader screen and open
the client console. The console will stay open until you are connected
to a game. After that, you can close it and open it again with the ESC key.
<p>
Type <i>connect</i> and press Enter. You will join the game as
spectator, type <i>join</i> in the console to join the game.
Type <i>spectate</i> to spectate again.
Type <i>disconnect</i> to return to the loader screen.
<p>
The client is capable of acting as a networked server. You can enable
the private server by setting <i>sv_private 1</i> before you <i>connect</i>.
This wil allow remote players to connect to your client.
<p>
To connect to a dedicated server, type <i>connect address</i>, where
adress is the hostname or IP address of the remote server.
<p>
In-game, you can aquire a ship with the <i>buy</i> command.
<h2>
Keyboard
</h2>
<p>
Keyboard controls can be configured with the <i>bind</i> command.
A key can be bound to an action or a console command. An action
always starts with a plus or minus sign.
<p>
To bind the keypad left key to the turn left action:
<pre>
bind kpleft +left
</pre>
<p>
To bind the P key to the screenshot command:
<pre>
bind p screenshot
</pre>
<p>
You can use the <i>list_binds</i> command to get a list of currently
bound keys. Use the 'list_keys' command to get a list of all
available key names.
<p>
The default configuration:
<table>
<tr><td>ESC or `
</td><td>toggle console
</td></tr>
<tr><td>v
</td><td>next camera view
</td></tr>
<tr><td>shift+v
</td><td>previous camera view
</td></tr>
<tr><td>space bar
</td><td>toggle mouse control on or off
</td></tr>
<tr><td>arrow left right up down
</td><td>rotate camera in free view
</td></tr>
<tr><td>keypad left right up down
</td><td>steer the ship left/right/up/down
</td></tr>
<tr><td>keypad / *
</td><td>roll left/right
</td></tr>
<tr><td>keypad + -
</td><td>increase/decrease forward thruster
</td></tr>
<tr><td>tab
</td><td>kinetic impulse drive control
</td></tr>
<tr><td>n
</td><td>Select next target
</td></tr>
<tr><td>shift+n
</td><td>Select previous target
</td></tr>
<tr><td>t
</td><td>Open the chat window
</td></tr>
<tr><td>print screen
</td><td>screenshot
</td></tr>
<table>
<h2>
Mouse
</h2>
<p>
If you have choosen Track or cockpit view and mouse control is actived,
you can use it to steer your vessel. In Free view mode, the mouse will rotate
the camera. If mouse control it is deactived, you can temporarily activate
it by pressing the left mouse button.
<p>
Use the scroll wheel to increase/decrease thruster.
<p>
Mouse buttons can also be configured through the <i>bind</i> command.
<h2>
Console functions
</h2>
<p>
The following commands are always available on the console:
<table>
<tr><td class="wide">connect</td><td>connect the client to the game module</td></tr>
<tr><td class="wide">disconnect</td><td>disconnect the client from the game module</td></tr>
<tr><td class="wide">list_ent</td><td>list registered entities</td></tr>
<tr><td class="wide">list_func</td><td>list registered functions</td></tr>
<tr><td class="wide">list_model</td><td>list registered models</td></tr>
<tr><td class="wide">list_var</td><td>list registered variables</td></tr>
<tr><td class="wide">quit</td><td>exit the application</td></tr>
<tr><td class="wide">r_restart</td><td>restart the video subsystem</td></tr>
</table>
<p>
The following commands are available when you are connected to a game:
<table>
<tr><td class="wide">join</td><td>join the game</td></tr>
<tr><td class="wide">spectate</td><td>spectate</td></tr>
<tr><td class="wide">buy</td><td>purchase a new ship</td></tr>
<tr><td class="wide">jump</td><td>active the hyperspace jump drive</td>
<tr><td class="wide">impulse</td><td>active the kinetic impulse drive</td>
<tr><td class="wide">who</td><td>list connected players</td></tr>
</table>
<p>
This list is far from complete. The <i>list_func</i> function will print
all available functions with a short description.
<h2>
Configuration variables
</h2>
<p>
A lot of settings can be changed through configuration variables.
The <i>list_var</i> function will print all available variables with
a short discription. To change the value of a variable, type its name
followed by the new value.
<p>
e.g.: to disable rendering of the sky:
<pre>
r_sky 0
</pre>
<p>
to enable it again:
<pre>
r_sky 1
</pre>
<p>
To change the video resolution, set the r_width and r_height variables and execute r_restart.
e.g.: to set the video mode to 1024x768 type:
<pre>
r_width 1024
r_height 768
r_restart
</pre>
<p>
To switch to fullscreen mode, set the r_fullscreen
variable to 1:
<pre>
r_fullscreen 1
r_restart
</pre>
<p>
You can set your name and player color through the cl_color
and cl_name variables. Note that your ship's colour won't
change until you buy a new one.
<pre>
cl_name SpaceCowboy
cl_color 1.0 1.0 0.0
connect
</pre>
<h2>
Statistics
</h2>
<p>
To activate statistics, set the draw_stats variable to 1:
<pre>
draw_stats 1
</pre>
<p>
This will draw the following statistics on the right side
of the screen:
<pre>
fps average framerate, frames per second
tris number of triangles
quads number of quads
net average network traffic, bytes per second
</pre>
<p>
The framerate is capped at around 1000 frames per second.
<h2>
Configuration files
</h2>
<p>
Variables marked with the 'A' flag will be archived, their value
will be written to the configuration file on exit. The dedicated
server reads its configuration from server.cfg, the client
will use client.cfg. Keyboard binds will be saved to binds.cfg
<p>
On UNIX systems you can find these files in the directory <i>~/.osirion/base</i>.
<p>
If you delete these files, the default configuration will be restored.
<h2>
Dedicated server
</h2>
<p>
By default, the dedicated server will accept incoming connections
on UDP port 8042. The server console os available if ncurses
support was enabled at compile time.
<p>
If you have trouble connecting, try editing the server configuration
file server.cfg and change the <i>net_server</i> variable to
the server's actual IP address. The default listening port can
be altered by changing the <i>net_port</i> variable.
<h2>
Command line
</h2>
<p>
Both the client and the dedicated server can parse command line
options. Any console command can be added to the command line with + sign.
<p>
To start a client and connect to a remote server:
<pre>
osirion +connect remote.server.org
</pre>
<p>
To start a client and create a new network game:
<pre>
osirion +set sv_private 1 +connect +join
</pre>
<p>
To start a dedicated server and set the server framerate to 30 frames per
second:
<pre>
osiriond +set sv_framerate 30
</pre>
<p> <b>Note:</b> setting variables from the command line can result in weird values being
written to client.cfg and server.cfg. If you run into problems, check those
files or delete them.
<h2>
Note for windows32 users
</h2>
<p>
On windows32, the game uses the <i>home</i> subdirectory as your personal
directory. For example, the client.ini can be found as <i>home\base\client.ini</i>.
<p>
There is also a problem that prevents the game from creating directories.
If you need any subdirectories in your personal folder, like <i>screenshots</i>,
you will have to create it manually.
</body>
</html>
|
