From 18f21c931e6e071b6616a1c0a07026af9b185ad5 Mon Sep 17 00:00:00 2001
From: Stijn Buys <ingar@osirion.org>
Date: Tue, 5 Aug 2008 14:01:46 +0000
Subject: manual section on joysticks

---
 doc/manual.html | 32 ++++++++++++++++++++++++++------
 1 file changed, 26 insertions(+), 6 deletions(-)

(limited to 'doc/manual.html')

diff --git a/doc/manual.html b/doc/manual.html
index 3284797..1f110ba 100644
--- a/doc/manual.html
+++ b/doc/manual.html
@@ -17,7 +17,7 @@
 <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.
+	to a game. Once connected you can close 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. 
@@ -121,6 +121,27 @@ bind p screenshot
 <p>
 	Mouse buttons can also be configured through the <i>bind</i> command.
 <h2>
+Joystick
+</h2>
+<p>
+	Joystick support is only preliminary and disabled by default. A list of detected
+	joysticks will apear in the startup messages. To use a joystick set the
+	<i>input_joystick</i> variable to the desired joystick number:
+<pre>
+input_joystick 1
+</pre>
+<p>
+	The axes are hardcoded and can not be configured. Axis 0 controls pitch, axis
+	1 controls direction, axis 2 control roll. There is no way to callibrate the
+	joystick, you will have to use an external joystick calibration program.
+<p>
+	Up to 16 joystick buttons will be reckognized. They can be configured by assigning
+	a command or action to keys <i>joy0</i> through <i>joy15</i>. For example, to configure
+	the first button to activate or deactivate the kinetic impulse drive:
+<pre>
+bind joy0 impulse
+</pre>
+<h2>
 Console functions
 </h2>
 <p>
@@ -159,12 +180,12 @@ Console functions
 <p>
 	e.g.: to disable rendering of the sky:
 <pre>
-	r_sky 0
+r_sky 0
 </pre>
 <p>
 	to enable it again:
 <pre>
-	r_sky 1
+r_sky 1
 </pre>
 <p>
 	To change the video resolution, set the r_width and r_height variables and execute r_restart.
@@ -251,10 +272,9 @@ osirion +connect remote.server.org
 osirion +set sv_private 1 +connect +join
 </pre>
 <p>
-	To start a dedicated server and set the server framerate to 30 frames per
-	second:
+	To start a dedicated server and set the server name to <i>My Osirion Server</i>:
 <pre>
-osiriond +set sv_framerate 30
+osiriond +set sv_name My Osirion Server
 </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 
-- 
cgit v1.2.3