documentation updates

author: Stijn Buys <ingar@osirion.org> 2008-07-14 20:41:12 +0000
committer: Stijn Buys <ingar@osirion.org> 2008-07-14 20:41:12 +0000
commit: 61c081e77a8e445bb92bbda4fcbd8cfea707e6de (patch)
tree: 829e56e67e654f0c6db185c279f1f70e3f9ecb7b /doc/manual.html
parent: 28d7a4cd5b4bc3df5d034ed9472231d91710a6b6 (diff)
1 files changed, 229 insertions, 0 deletions
diff --git a/doc/manual.html b/doc/manual.html
new file mode 100644
index 0000000..aab5542
--- /dev/null
+++ b/doc/manual.html
@@ -0,0 +1,229 @@
+<!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>
+<H1>
+	The Osirion Project - User manual
+</H1>
+
+<h2>
+	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.
+	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>~ 
+	</td><td>toggle console
+	</td></tr>
+	
+	<tr><td>V
+	</td><td>switch between track, cockpit and free view
+	</td></tr>
+	
+	<tr><td>space bar
+	</td><td>toggle mouse control on or off
+	</td></tr>
+	
+	<tr><td>left right up down arrow 
+	</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>T
+	</td><td>open the chat window
+	</td></tr>
+
+	<tr><td>print screen
+	</td><td>screenshot
+	</td></tr>
+<table>
+<h2>
+	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.
+<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>connect		</td><td>connect the client to the game module</td></tr>
+	<tr><td>disconnect	</td><td>disconnect the client from the game module</td></tr>
+	<tr><td>list_ent	</td><td>list registered entities</td></tr>
+	<tr><td>list_func	</td><td>list registered functions</td></tr>
+	<tr><td>list_model	</td><td>list registered models</td></tr>
+	<tr><td>list_var	</td><td>list registered variables</td></tr>
+	<tr><td>quit		</td><td>exit the application</td></tr>
+	<tr><td>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>join		</td><td>join the game</td></tr>
+	<tr><td>spectate	</td><td>spectate</td></tr>
+	<tr><td>buy		</td><td>purchase a new ship</td></tr>
+	<tr><td>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.
+	e.g.: to set the video mode to 1024x768 type:
+<pre>
+r_width 1024
+r_height 768
+r_restart
+</pre>
+<p></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:
+
+		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
+<p>
+	The fps counter will not show values above 9999.
+<h2>
+	Configuration
+</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.
author	Stijn Buys <ingar@osirion.org>	2008-07-14 20:41:12 +0000
committer	Stijn Buys <ingar@osirion.org>	2008-07-14 20:41:12 +0000
commit	61c081e77a8e445bb92bbda4fcbd8cfea707e6de (patch)
tree	829e56e67e654f0c6db185c279f1f70e3f9ecb7b /doc/manual.html
parent	28d7a4cd5b4bc3df5d034ed9472231d91710a6b6 (diff)