diff options
Diffstat (limited to 'doc/manual.html')
| -rw-r--r-- | doc/manual.html | 299 |
1 files changed, 235 insertions, 64 deletions
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 @@ <html lang="en"> <head> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> + <link rel="stylesheet" type="text/css" href="main.css"> <TITLE>Project::OSiRiON - User manual</TITLE> </head> <body> -<H1> - Project::OSiRiON - User manual -</H1> +<div class="banner"> + <img src="images/banner.png" ALT="Project::OSiRiON"> + <br> + User Manual +</div> +<div class="text"> +<p> + <i>Note: this document is undergoing major changes and is currently a mix of older and updated content.</i> +</p> +</div> +<div class="text"> +<p> + 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 <b>~</b> key. +</p><p> + 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. +</p> +</div> + +<!-- =============================================================== --> + +<div class="title"> + Basics +</div> + +<div class="text"> +<p> + 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 <b>page up</b> and <b>page down</b> to see older messages. + The client console can also be scrolled using the mousewheel. +</p><p> + 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. +</p> + +</div> + +<div class="subtitle"> + Variables +</div> +<div class="text"> +<p> + 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. +</p> <p> - Note: the manual is outdated. + The <span class="fixed">list_var</span> functions will print a list of available variables: type + <span class="fixed">list_var</span> on the console followed by <b>enter</b>. </p> -<h2> +<pre class="code"> +>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 +</pre> +<p> + 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 <b>enter</b>. +</p> +<pre class="code"> +>sv_name + sv_name osirion server [string] server name +</pre> +<p> + TODO: variable flags A=Archive G=Game R=ReadOnly +</p> +<p> + TODO: changing variable value +</p> +</div> + +<div class="subtitle"> + Functions +</div> +<div class="text"> + TODO Concerning commands +</div> + +<div class="subtitle"> + Command line options +</div> +<div class="text"> + TODO Concerning command line options +</div> + +<!-- =============================================================== --> +<div class="title"> Client -</h2> +</div> +<div class="text"> + <div class="rfloater"><img src="images/client_console.png" alt=""></div> <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. 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. - Type <i>spectate</i> to spectate again. - Type <i>disconnect</i> to return to the loader screen. -<p> +</p><p> + Type <span class="fixed">connect</span> and press Enter. You will join the game as + spectator, type <span class="fixed">join</span> in the console to join the game. + Type <span class="fixed">spectate</span> to spectate again. + Type <span class="fixed">disconnect</span> to return to the loader screen. +</p> +<!--<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>. + the private server by setting <span class="fixed">sv_private 1</span> before you <span class="fixed">connect</span>. This wil allow remote players to connect to your client. +</p>--> <p> - To connect to a dedicated server, type <i>connect address</i>, where + To connect to a dedicated server, type <span class="fixed">connect address</span>, where adress is the hostname or IP address of the remote server. +</p><p> + If you started a local game and want to have a quick look around you can enable + cheats by setting the <span class="fixed">g_devel</span> variable. Once cheats are enabled, + you can use the <span class="fixed">give ship</span> command to try out new ships + ad the <span class="fixed">give cargo</span> command to fill up your cargo hold for free. +</p> +<p> + This example will swap your current ship for the Micron Matrix model, and fill its cargo + hold with 5 units of gold: +</p> +<pre class="code"> +g_devel 1 +give ship matrix +give cargo gold 5 +</pre> <p> - In-game, you can aquire a ship with the <i>buy</i> command. -<h2> + You can also eject the cargo into space: +</p> + +<pre class="code"> +eject cargo gold 5 +</pre> + +<p> + A particulary amusing way to test the engine is the following command combo (the double qoutes are mandatory): +</p> +<pre class="code"> +bind k "give cargo gold 1; eject cargo gold 1" +</pre> +<p> + This command combination will make the k key spit a cargo pod into space. +</p> +</div> + +<!-- =============================================================== --> +<div class="subtitle"> Keyboard -</h2> +</div> +<div class="text"> <p> - Keyboard controls can be configured with the <i>bind</i> command. + Keyboard controls can be configured with the <span class="fixed">bind</span> command. A key can be bound to an action or a console command. An action always starts with a plus or minus sign. <p> @@ -52,8 +184,8 @@ bind kpleft +left bind p screenshot </pre> <p> - You can use the <i>list_binds</i> command to get a list of currently - bound keys. Use the <i>list_keys</i> command to get a list of all + You can use the <span class="fixed">list_binds</span> command to get a list of currently + bound keys. Use the <span class="fixed">list_keys</span> command to get a list of all available key names. <p> The default configuration: @@ -135,9 +267,13 @@ bind p screenshot </td><td>screenshot </td></tr> </table> -<h2> +</div> + +<!-- =============================================================== --> +<div class="subtitle"> Mouse -</h2> +</div> +<div class="text"> <p> 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 <p> Use the scroll wheel to increase/decrease thruster. <p> - Mouse buttons can also be configured through the <i>bind</i> command. -<h2> + Mouse buttons can also be configured through the <span class="fixed">bind</span> command. +</div> + + +<!-- =============================================================== --> +<div class="subtitle"> Joystick -</h2> +</div> +<div class="text"> <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: + <span class="fixed">input_joystick</span> variable to the desired joystick number: <pre> input_joystick 1 </pre> @@ -163,14 +304,18 @@ input_joystick 1 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 + a command or action to keys <span class="fixed">joy0</span> through <span class="fixed">joy15</span>. For example, to configure the first button to activate or deactivate the kinetic impulse drive: <pre> bind joy0 impulse </pre> -<h2> +</div> + +<!-- =============================================================== --> +<div class="subtitle"> Console functions -</h2> +</div> +<div class="text"> <p> The following commands are always available on the console: <table> @@ -194,14 +339,18 @@ Console functions <tr><td class="wide">who</td><td>list connected players</td></tr> </table> <p> - This list is far from complete. The <i>list_func</i> function will print + This list is far from complete. The <span class="fixed">list_func</span> function will print all available functions with a short description. -<h2> +</div> + +<!-- =============================================================== --> +<div class="subtitle"> Configuration variables -</h2> +</div> +<div class="text"> <p> A lot of settings can be changed through configuration variables. - The <i>list_var</i> function will print all available variables with + The <span class="fixed">list_var</span> 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> @@ -216,10 +365,10 @@ 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: + e.g.: to set the video mode to 1680x1050 type: <pre> -r_width 1024 -r_height 768 +r_width 1680 +r_height 1050 r_restart </pre> <p> @@ -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. <pre> -cl_name SpaceCowboy +cl_name SpaceCadet cl_color 1.0 1.0 0.0 connect </pre> +</div> -<h2> +<!-- =============================================================== --> +<div class="subtitle"> Statistics -</h2> +</div> +<div class="text"> <p> To activate statistics, set the draw_stats variable to 1: <pre> @@ -256,65 +408,84 @@ quads number of quads net average network traffic, bytes per second </pre> <p> - The framerate is capped at around 1000 frames per second. -<h2> - Configuration files -</h2> + The framerate is limited to 1000 frames per second. +</div> + +<!-- =============================================================== --> +<div class="subtitle"> + Configuration variables +</div> +<div class="text"> <p> 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 <i>server.cfg</i>, the client will use <i>client.cfg</i>. - Keyboard binds will be saved to <i>binds.cfg</i>. Game settings will be saved to <i>game.cfg</i>. + reads its configuration from <span class="fixed">server.cfg</span>, the client will use <span class="fixed">client.cfg</span>. + Keyboard binds will be saved to <span class="fixed">binds.cfg</span>. Game settings will be saved to <span class="fixed">game.cfg</span>. <p> - On UNIX systems you can find these files in the directory <i>~/.osirion/base</i>. + On UNIX systems you can find these files in the directory <span class="fixed">~/.osirion/base</span>. <p> If you delete these files, the default configuration will be restored. -<h2> +</div> + +<!-- =============================================================== --> +<div class="title"> Dedicated server -</h2> +</div> +<div class="text"> +<div class="rfloater"><img src="images/server_console.png" alt=""></div> <p> 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. <p> If you have trouble connecting, try editing the server configuration - file server.cfg and change the <i>net_server</i> variable to + file server.cfg and change the <span class="fixed">net_server</span> variable to the server's actual IP address. The default listening port can - be altered by changing the <i>net_port</i> variable. -<h2> + be altered by changing the <span class="fixed">net_port</span> variable. +</div> + +<!-- =============================================================== --> +<div class="title"> Command line -</h2> +</div> +<div class="text"> <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> +</p><p> To start a client and connect to a remote server: +</p> <pre> osirion +connect remote.server.org </pre> <p> To start a client and create a new network game: +</p> <pre> osirion +set sv_private 1 +connect +join </pre> <p> - To start a dedicated server and set the server name to <i>My Osirion Server</i>: + To start a dedicated server and set the server name to <span class="fixed">My Osirion Server</span>: +</p> <pre> 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 files or delete them. -<h2> - Note for windows users -</h2> -<p> - On windows32, the game uses the <i>My Documents\My Games\Osirion</i> subdirectory as your personal - directory. For example, the client.ini can be found as <i>My Documents\My Games\Osirion\base\client.ini</i>. +</p> +</div> -<h2 class="navigate"> - <a href="index.html">back</a> -</h2> +<!-- =============================================================== --> +<div class="title"> + Operating System specific notes +</div> +<div class="text"> +<p> + On windows32, the game uses the <span class="fixed">My Documents\My Games\Osirion</span> subdirectory as your personal + directory. For example, the client.ini can be found as <span class="fixed">My Documents\My Games\Osirion\base\client.ini</span>. +</p> +</div> </body> </html> |