From 5645248a9a91c6037b935043a4e7037072bf9366 Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Sat, 6 Nov 2010 18:57:00 +0000 Subject: documentation restyling --- doc/manual.html | 299 ++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 235 insertions(+), 64 deletions(-) (limited to 'doc/manual.html') diff --git a/doc/manual.html b/doc/manual.html index 24fcc81..f89cdca 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -2,43 +2,175 @@ - + Project::OSiRiON - User manual -

- Project::OSiRiON - User manual -

+ +
+

+ Note: this document is undergoing major changes and is currently a mix of older and updated content. +

+
+
+

+ Most features of the engine can by used by typing text commands into the + command console. Both the client and the dedicated have their own console: the one on + the dedicated server is always visible, and is the only way to send commands to the server. + The command console in the client is usually hidden and can be opened by pressing the ~ key. +

+ Some commands are only available on a server, other commands are only available while running + a client. If you are playing a local game, you are actually running your own local server + and server commands will als be available through the client command console as well. +

+
+ + + +
+ Basics +
+ +
+

+ If you open the client console or look at the server console will see + all messages the server has send to the console so far. You can scroll + up and down using page up and page down to see older messages. + The client console can also be scrolled using the mousewheel. +

+ Warning messages are usually printed in yellow, important error message in red. + If you encounter problems, the console is usually the best place to look for information. +

+ +
+ +
+ Variables +
+
+

+ The console can be used to change a number of configuration variables: these variables + are used to store various settings and by changing these values the engine and the game + can be customized to the user's preference. +

- Note: the manual is outdated. + The list_var functions will print a list of available variables: type + list_var on the console followed by enter.

-

+
+>list_var 
+ A   cl_color 1 1 .5 [r g b] player primary color
+ A   cl_colorsecond 1 .5 0 [r g b] player secondary color
+ .
+ .
+ .
+ A   sv_name osirion server [string] server name
+ A   sv_password  [string] server rcon password
+     sv_private 0 [bool] enable or disable network server for a client
+  Flags: A=Archive G=Game R=ReadOnly
+  71 registered variables
+
+

+ For each available variable, the list_var function will print the variable's flags, + name, its current value and a short description. To inspect the current value of + a single variable, just type its name on the console followed by enter. +

+
+>sv_name
+  sv_name osirion server [string] server name
+
+

+ TODO: variable flags A=Archive G=Game R=ReadOnly +

+

+ TODO: changing variable value +

+

+ +
+ Functions +
+
+ TODO Concerning commands +
+ +
+ Command line options +
+
+ TODO Concerning command line options +
+ + +
Client - +
+
+

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. Once connected you can close 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. -

+

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

+

- To connect to a dedicated server, type connect address, where + To connect to a dedicated server, type connect address, where adress is the hostname or IP address of the remote server. +

+ If you started a local game and want to have a quick look around you can enable + cheats by setting the g_devel variable. Once cheats are enabled, + you can use the give ship command to try out new ships + ad the give cargo command to fill up your cargo hold for free. +

+

+ This example will swap your current ship for the Micron Matrix model, and fill its cargo + hold with 5 units of gold: +

+
+g_devel 1
+give ship matrix
+give cargo gold 5
+

- In-game, you can aquire a ship with the buy command. -

+ You can also eject the cargo into space: +

+ +
+eject cargo gold 5
+
+ +

+ A particulary amusing way to test the engine is the following command combo (the double qoutes are mandatory): +

+
+bind k "give cargo gold 1; eject cargo gold 1"
+
+

+ This command combination will make the k key spit a cargo pod into space. +

+

+ + +
Keyboard - +
+

- Keyboard controls can be configured with the bind command. + Keyboard controls can be configured with the bind command. A key can be bound to an action or a console command. An action always starts with a plus or minus sign.

@@ -52,8 +184,8 @@ bind kpleft +left bind p screenshot

- You can use the list_binds command to get a list of currently - bound keys. Use the list_keys command to get a list of all + You can use the list_binds command to get a list of currently + bound keys. Use the list_keys command to get a list of all available key names.

The default configuration: @@ -135,9 +267,13 @@ bind p screenshot screenshot -

+

+ + +
Mouse - +
+

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 @@ -146,14 +282,19 @@ bind p screenshot

Use the scroll wheel to increase/decrease thruster.

- Mouse buttons can also be configured through the bind command. -

+ Mouse buttons can also be configured through the bind command. +

+ + + +
Joystick - +
+

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 - input_joystick variable to the desired joystick number: + input_joystick variable to the desired joystick number: 

 input_joystick 1
@@ -163,14 +304,18 @@ input_joystick 1 joystick, you will have to use an external joystick calibration program.

Up to 16 joystick buttons will be reckognized. They can be configured by assigning - a command or action to keys joy0 through joy15. For example, to configure + a command or action to keys joy0 through joy15. For example, to configure the first button to activate or deactivate the kinetic impulse drive: 

 bind joy0 impulse
-

+

+ + +
Console functions - +
+

The following commands are always available on the console: @@ -194,14 +339,18 @@ Console functions
wholist connected players

- This list is far from complete. The list_func function will print + 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 + 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.

@@ -216,10 +365,10 @@ 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: + e.g.: to set the video mode to 1680x1050 type: 

-r_width 1024
-r_height 768
+r_width 1680
+r_height 1050
 r_restart

@@ -233,14 +382,17 @@ r_fullscreen 1 and cl_name variables. Note that your ship's colour won't change until you buy a new one. 

-cl_name SpaceCowboy
+cl_name SpaceCadet
 cl_color 1.0 1.0 0.0
 connect
+
-

+ +
Statistics -

+ +

To activate statistics, set the draw_stats variable to 1: 

@@ -256,65 +408,84 @@ quads	number of quads
 net	average network traffic, bytes per second

- The framerate is capped at around 1000 frames per second. -

- Configuration files -

+ The framerate is limited to 1000 frames per second. +
+ + +
+ Configuration variables +
+

Variables marked with the 'A' flag will be archived. Their values will be loaded from and saved to the configuration files. The dedicated server - reads its configuration from server.cfg, the client will use client.cfg. - Keyboard binds will be saved to binds.cfg. Game settings will be saved to game.cfg. + reads its configuration from server.cfg, the client will use client.cfg. + Keyboard binds will be saved to binds.cfg. Game settings will be saved to game.cfg.

- On UNIX systems you can find these files in the directory ~/.osirion/base. + On UNIX systems you can find these files in the directory ~/.osirion/base.

If you delete these files, the default configuration will be restored. -

+

+ + +
Dedicated server - +
+
+

By default, the dedicated server will accept incoming connections on UDP port 8042. The server console is available if ncurses support was enabled at compile time.

If you have trouble connecting, try editing the server configuration - file server.cfg and change the net_server variable to + file server.cfg and change the net_server variable to the server's actual IP address. The default listening port can - be altered by changing the net_port variable. -

+ be altered by changing the net_port variable. +

+ + +
Command line - +
+

Both the client and the dedicated server can parse command line options. Any console command can be added to the command line with + sign. -

+

To start a client and connect to a remote server: +

 osirion +connect remote.server.org

To start a client and create a new network game: +

 osirion +set sv_private 1 +connect +join

- To start a dedicated server and set the server name to My Osirion Server: + To start a dedicated server and set the server name to My Osirion Server: +

 osiriond +set sv_name My Osirion Server

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

- Note for windows users -

-

- On windows32, the game uses the My Documents\My Games\Osirion subdirectory as your personal - directory. For example, the client.ini can be found as My Documents\My Games\Osirion\base\client.ini. +

+
-

- back -

+ +
+ Operating System specific notes +
+
+

+ On windows32, the game uses the My Documents\My Games\Osirion subdirectory as your personal + directory. For example, the client.ini can be found as My Documents\My Games\Osirion\base\client.ini. +

+
-- cgit v1.2.3