<!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> <body> <H1> The Osirion Project - User manual </H1> <p> Note: the manual is outdated. </p> <h2> Client </h2> <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> 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 <i>list_keys</i> command to get a list of all available key names. <p> The default configuration: <table> <tr><td>ESC or ` </td><td>toggle console </td></tr> <tr><td>v </td><td>next camera view </td></tr> <tr><td>shift+v </td><td>previous camera view </td></tr> <tr><td>left right up down </td><td>rotate camera in free view </td></tr> <tr><td>keypad left right </td><td>direction </td></tr> <tr><td>keypad up down </td><td>pitch </td></tr> <tr><td>keypad home pgup </td><td>roll </td></tr> <tr><td>keypad + - </td><td>increase/decrease forward thruster </td></tr> <tr><td>space bar </td><td>toggle mouse control on or off </td></tr> <tr><td>tab </td><td>kinetic impulse drive control </td></tr> <tr><td>a d </td><td>strafe </td></tr> <tr><td>q e </td><td>roll </td></tr> <tr><td>w s </td><td>afterburner/reverse </td></tr> <tr><td>n </td><td>select next target </td></tr> <tr><td>shift+n </td><td>select previous target </td></tr> <tr><td>ctrl+n </td><td>deselect current target </td></tr> <tr><td>t </td><td>chat box </td></tr> <tr><td>enter </td><td>chat window </td></tr> <tr><td>print screen </td><td>screenshot </td></tr> </table> <h2> Mouse </h2> <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 the camera. If mouse control it is deactived, you can temporarily activate it 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> 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> The following commands are always available on the console: <table> <tr><td class="wide">connect</td><td>connect the client to the game module</td></tr> <tr><td class="wide">disconnect</td><td>disconnect the client from the game module</td></tr> <tr><td class="wide">list_ent</td><td>list registered entities</td></tr> <tr><td class="wide">list_func</td><td>list registered functions</td></tr> <tr><td class="wide">list_model</td><td>list registered models</td></tr> <tr><td class="wide">list_var</td><td>list registered variables</td></tr> <tr><td class="wide">quit</td><td>exit the application</td></tr> <tr><td class="wide">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 class="wide">join</td><td>join the game</td></tr> <tr><td class="wide">spectate</td><td>spectate</td></tr> <tr><td class="wide">buy</td><td>purchase a new ship</td></tr> <tr><td class="wide">jump</td><td>active the hyperspace jump drive</td> <tr><td class="wide">impulse</td><td>active the kinetic impulse drive</td> <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 all available functions with a short description. <h2> Configuration variables </h2> <p> A lot of settings can be changed through configuration variables. The <i>list_var</i> 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> e.g.: to disable rendering of the sky: <pre> r_sky 0 </pre> <p> to enable it again: <pre> 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: <pre> r_width 1024 r_height 768 r_restart </pre> <p> To switch to fullscreen mode, set the r_fullscreen variable to 1: <pre> r_fullscreen 1 </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: <pre> fps average framerate, frames per second tris number of triangles 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> <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>. <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 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 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 name to <i>My Osirion Server</i>: <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>. <h2 class="navigate"> <a href="index.html">back</a> </h2> </body> </html>