From e685db34cb94e4bef564da4afdaa7a18b1819c09 Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Sun, 3 Aug 2008 17:58:10 +0000 Subject: documentation, extra sound warnings, network bytes/sec --- doc/TODO | 23 +++++++++----- doc/manual.html | 94 ++++++++++++++++++++++++++++++++++++++++----------------- 2 files changed, 82 insertions(+), 35 deletions(-) (limited to 'doc') diff --git a/doc/TODO b/doc/TODO index 8f2c5bf..1ae6577 100644 --- a/doc/TODO +++ b/doc/TODO @@ -1,20 +1,21 @@ TODO -milestone 1: +version 0.1: fix turning (needs more testing) fix cl_prediction (or not) fix autolevel + zone/entity network interaction - add impulse drive -milestone 2: - zones +version 0.2: + + docking targetting system server-client event system, hit-once lightweight entities explosion events weapons fire events -milestone 3: +version 0.3: gui filesystem: @@ -60,10 +61,14 @@ network: rcon authentication, rcon command, servers must be able to disable rcon zone changes - send clients only updates from the current zone + send clients only updates from the current zone/server-side distance check fix lag/client interpolation rename cl_prediction to cl_interpolation detect and disconnect clients behaving badly + EXT messages, update extended property "ext id prop value prop value etc", type checking/serperator etc.. + EXT zone/color/shield/armor/health + round thrust/speed on 1/100, location on 1/1000 before send + stable ent/die client: console chars (ok) @@ -79,6 +84,8 @@ client: view_next, view_prev (ok) mouse select on release event while + tracking camera absolute speed + visual feedback on impulse drive render: render pipeline (ok) @@ -102,13 +109,13 @@ sound: enitity/event positional sounds game: + add impulse drive (ok) + implement player credits entity health/shield/armor gui concept artwork docking jumpgates (required docking) - fix autolevel - impulse drive win32 port: network not functional (ok) 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

- Starting the client will show the loader screen. - To start the game, open the client console with the ~ key and type connect. - You will join the game as spectator, type join in the console - to join the game. Type spectate 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. +

+ Type connect and press Enter. You will join the game as + spectator, type join in the console to join the game. + Type spectate to spectate again. Type disconnect to return to the loader screen.

The client is capable of acting as a networked server. You can enable @@ -53,19 +56,23 @@ bind p screenshot

The default configuration: - - + + - @@ -81,8 +88,20 @@ bind p screenshot - + + + + + + - +
~ +
ESC or ` toggle console
V - switch between track, cockpit and free view +
v + next camera view +
shift+v + previous camera view
space bar toggle mouse control on or off
left right up down arrow +
arrow left right up down rotate camera in free view
increase/decrease forward thruster
T - open the chat window +
tab + kinetic impulse drive control +
n + Select next target +
shift+n + Select previous target +
t + Open the chat window
print screen @@ -93,11 +112,10 @@ bind p screenshot Mouse

- 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. -

- 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.

Use the scroll wheel to increase/decrease thruster.

@@ -115,7 +133,7 @@ Console functions

list_modellist registered models
list_varlist registered variables
quitexit the application
r_restart restart the video subsystem
r_restartrestart the video subsystem

The following commands are available when you are connected to a game: @@ -123,18 +141,40 @@ Console functions joinjoin the game spectatespectate buypurchase a new ship + jumpactive the hyperspace jump drive + impulseactive the kinetic impulse drive wholist connected players

- To change the video resolution, set the r_width and - r_height variables and execute r_restart. + This list is far from complete. The list_func function will print + all available functions with a short description. +

+ Configuration variables +

+

+ A lot of settings can be changed through configuration variables. + The list_var 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. +

+ e.g.: to disable rendering of the sky: +

+	r_sky 0
+
+

+ to enable it again: +

+	r_sky 1
+
+

+ 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: 

 r_width 1024
 r_height 768
 r_restart
-

+

To switch to fullscreen mode, set the r_fullscreen variable to 1: 

@@ -162,16 +202,16 @@ draw_stats 1
 

 	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
+
+fps	average framerate, frames per second
+tris	number of triangles
+quads	number of quads
+net	average network traffic, bytes per second
+

 

-	The fps counter will not show values above 9999.
+	The framerate is capped at around 1000 frames per second.
 

-	Configuration
+	Configuration files
 

 

 	Variables marked with the 'A' flag will be archived, their value 
-- 
cgit v1.2.3