Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual.html')
-rw-r--r--doc/manual.html94
1 files changed, 67 insertions, 27 deletions
diff --git a/doc/manual.html b/doc/manual.html
index 494b29f..3284797 100644
--- a/doc/manual.html
+++ b/doc/manual.html
@@ -15,10 +15,13 @@
Client
</h2>
<p>
- Starting the client will show the loader screen.
- To start the game, open the client console with the ~ key and type <i>connect</i>.
- 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.
+ 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
@@ -53,19 +56,23 @@ bind p screenshot
<p>
The default configuration:
<table>
- <tr><td>~
+ <tr><td>ESC or `
</td><td>toggle console
</td></tr>
- <tr><td>V
- </td><td>switch between track, cockpit and free view
+ <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>left right up down arrow
+ <tr><td>arrow left right up down
</td><td>rotate camera in free view
</td></tr>
@@ -81,8 +88,20 @@ bind p screenshot
</td><td>increase/decrease forward thruster
</td></tr>
- <tr><td>T
- </td><td>open the chat window
+ <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
@@ -93,11 +112,10 @@ bind p screenshot
Mouse
</h2>
<p>
- If mouse control is on, you can use it to steer your vessel
- in track or cockpit view, or to rotate the camera in free view.
-<p>
- If mouse control is disabled, you can temporarily enable it again
- by pressing the left mouse button.
+ 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>
@@ -115,7 +133,7 @@ Console functions
<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>
+ <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:
@@ -123,18 +141,40 @@ Console functions
<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>
- To change the video resolution, set the r_width and
- r_height variables and execute r_restart.
+ 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></p>
+<p>
To switch to fullscreen mode, set the r_fullscreen
variable to 1:
<pre>
@@ -162,16 +202,16 @@ draw_stats 1
<p>
This will draw the following statistics on the right side
of the screen:
-
- fps frames per second
- tris number of triangles drawn
- quads number of quads drawn
- tx network upstream traffic, in kilobytes
- rx network downstream traffic, in kilobyte
+<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 fps counter will not show values above 9999.
+ The framerate is capped at around 1000 frames per second.
<h2>
- Configuration
+ Configuration files
</h2>
<p>
Variables marked with the 'A' flag will be archived, their value