diff options
| -rw-r--r-- | doc/guide.html | 10 | ||||
| -rw-r--r-- | doc/installation.html | 53 | ||||
| -rw-r--r-- | doc/main.css | 21 | ||||
| -rw-r--r-- | doc/manual.html | 299 | ||||
| -rw-r--r-- | doc/style.css | 88 |
5 files changed, 282 insertions, 189 deletions
diff --git a/doc/guide.html b/doc/guide.html index 08414e6..33262b8 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -38,14 +38,14 @@ <div class="rfloater"><img src="images/main_menu.jpg" alt=""></div> <p> When the client has started it will show you the main menu. Click the - <i>Start</i> button to start a game, or click the <i>Internet</i> + <span class="fixed">Start</span> button to start a game, or click the <span class="fixed">Internet</span> button to connect to the test server. </p><p> - The <i>Options</i> button will open the options menu where you can + The <span class="fixed">Options</span> button will open the options menu where you can customize a number of settings. </p><p> When the game has started it will show you the game menu. Click the - <i>Join</i> button to join the game, or click the <i>Disconnect</i> + <span class="fixed">Join</span> button to join the game, or click the <span class="fixed">Disconnect</span> button to leave the game and return to the main menu. </p><p> <img src="keys/f1.png" ALT=""> Later on, you can press <b>f1</b> to return to the main menu. @@ -56,7 +56,7 @@ a small trading outpost on the edge of the civilized world. You begin the game as the proud owner of a small trading vessel and a modest amount of credits. </p><p> - <img src="icons/launch.png" ALT=""> Click the <i>Launch</i> icon on the top of the screen to launch into space. + <img src="icons/launch.png" ALT=""> Click the <span class="fixed">Launch</span> icon on the top of the screen to launch into space. </p> </div> @@ -72,7 +72,7 @@ <p> After launch, you will be at the helm of your spaceship, right outside the space station. Let's take a moment to look around. There are three camera views you can choose from: - <i>tracking view</i>, the default mode, <i>cockpit view</i> and <i>free view</i>. + <span class="fixed">track</span>, the default mode, <span class="fixed">cockpit</span> and <span class="fixed">free</span>. </p><p> <img src="keys/v.png" ALT=""> Press <b>v</b> to switch to the next view. </p><p> diff --git a/doc/installation.html b/doc/installation.html index 8631686..24e4fa6 100644 --- a/doc/installation.html +++ b/doc/installation.html @@ -68,10 +68,10 @@ <p> Unzip the executables package into an approriate directory. Unzip the gama data package into this directory. For example, if you unzipped the data and the executables into - <i>D:\Osirion</i> then there should be a directory <i>D:\Osirion\data\base</i> containing the + <span class="fixed">D:\Osirion</span> then there should be a directory <span class="fixed">D:\Osirion\data\base</span> containing the game data. <p> - Open the game directory in explorer and click on <i>osirion.exe</i> to start the client. + Open the game directory in explorer and click on <span class="fixed">osirion.exe</span> to start the client. </div> <div class="subtitle"> @@ -190,7 +190,7 @@ sudo make install<br> </p> <p> On linux, you can use the Subversion command line client tool. The following - command will create a new subdirectory <i>osirion</i> and download the source code into it. + command will create a new subdirectory <span class="fixed">osirion</span> and download the source code into it. </p> <div class="code"> svn co svn://intranifty.no-ip.org/osirion osirion @@ -224,28 +224,26 @@ autoreconf -fi<br> <p> If you do not need the client and want to build the dedicated server only - you can pass the <i>--without-client</i> option to <i>configure</i>: + you can pass the <span class="fixed">--without-client</span> option to <span class="fixed">configure</span>: </p> <p> - Configure will automaticly detect the bullet library if itwass installed in <i>/usr/local</i>. - If it was installed somewhere else you will have to pass the <i>--with-bullet=directory</i> option - to configure. -</p> -</p> - For example, if you want to use the system-provided package on Arch linux, use - <i>--with-bullet=/usr</i>. + Configure will automaticly detect the bullet library if it was installed in <span class=fixed>/usr/local</span>. + If it was installed somewhere else you will have to pass the <span class="fixed">--with-bullet=directory</span> option + to configure. For example, <span class="fixed">--with-bullet=/usr</span> will use the bullet libraries installed in + <span class="fixed">/usr/lib</span> and the includes in <span class="fixed">/usr/include/bullet</span>. + </p> <div class="code"> ./configure --without-client </div> <p> - If <i>configure</i> finds ncurses or pdcurses, the dedicated server will use this + If <span class="fixed">configure</span> finds ncurses or pdcurses, the dedicated server will use this library and a have a curses console. To disable curses detection, pass the - <i>--without-curses</i> option to <i>configure</i>. + <span class="fixed">--without-curses</span> option to <span class="fixed">configure</span>. </p> <p> - <b>Important</b>: <i>make install</i> is not supported. Results are unpredictable. + <b>Important</b>: <span class="fixed">make install</span> is not supported. Results are unpredictable. </p> <p> Compile the source code: @@ -254,7 +252,7 @@ autoreconf -fi<br> make </div> <p> - The binaries will be build in the <i>src</i> subdirectory of the main distribution. + The binaries will be build in the <span class="fixed">src</span> subdirectory of the main distribution. </p> </div> @@ -263,7 +261,7 @@ make </div> <div class="text"> <p> - The game data should be located in the <i>data</i> subdirectory of the main distribution. + The game data should be located in the <span class="fixed">data</span> subdirectory of the main distribution. You can use the game data package from the website or get it from the osirion-data subversion repository: <ul> <li><a href="svn://intranifty.no-ip.org/osirion-data">svn://intranifty.no-ip.org/osirion-data</a> @@ -271,7 +269,7 @@ make </p> <p> Run the following command from within the main distribution directory to download - the game data into the <i>data</i> subdirectory: + the game data into the <span class="fixed">data</span> subdirectory: </p> <div class="code"> svn checkout svn://intranifty.no-ip.org/osirion-data data @@ -284,9 +282,9 @@ svn checkout svn://intranifty.no-ip.org/osirion-data data </div> <div class="text"> <p> - The client and the dedicated server will look for game data in the <i>data</i> subdirectory - of the current working directory. Since the binaries are build in the <i>src</i> you will - have start them with the <i>src/</i> prefix. + The client and the dedicated server will look for game data in the <span class="fixed">data</span> subdirectory + of the current working directory. Since the binaries are build in the <span class="fixed">src</span> you will + have start them with the <span class="fixed">src/</span> prefix. </p> <p> To start the client: @@ -305,7 +303,7 @@ src/osirion src/osiriond </div> <p> - If you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>. + If you are using windows, the binaries will be called <span class="fixed">osirion.exe</span> and <span class="fixed">osiriond.exe</span>. </p> </div> @@ -354,7 +352,7 @@ make </ul> <p> These instructions assume gtkradiant is installed in the directory - <i>/usr/local/games/netradiant</i>. If it is installed in a different + <span class="fixed">/usr/local/games/netradiant</span>. If it is installed in a different directory on your system, edit these instructions accordingly. <p> Copy the support files to the gtkradiant folder: @@ -365,20 +363,20 @@ cd gtkradiant<br> cp -vr * /usr/local/games/netradiant </div> <p> - Open the file <i>/usr/local/games/netradiant/games/osirion.game</i> in + Open the file <span class="fixed">/usr/local/games/netradiant/games/osirion.game</span> in your favourite editor. Look for a line that begins with: </p> <div class="code"> -enginepath_linux=" +enginepath_linux= </div> <p> Make sure it points to your osirion data directory. For example, - if you checked out the source code in <i>/home/yourname/osirion</i>, - then the data will be in <i>/home/yourname/osirion/data</i> and + if you checked out the source code into <span class="fixed">/home/user/osirion</span>, + then the data will be in <span class="fixed">/home/user/osirion/data</span> and the line should look like this: </p> <div class="code"> -enginepath_linux="/home/yourname/osirion/data" +enginepath_linux="/home/user/osirion/data" </div> <p> Save the changes. @@ -438,6 +436,7 @@ Organization of the distribution /maps 3D models (.map format) /materials material definitions /models 3D models (ase and other formats) + /particles particle definitions /textures game world textures /gtkradiant radiant support files diff --git a/doc/main.css b/doc/main.css index 80704ee..e4321ea 100644 --- a/doc/main.css +++ b/doc/main.css @@ -57,7 +57,7 @@ img { float: right; } -.banner, .header, .footer, .title { +.banner, .header, .footer { background: #d7d7d7; margin-left: 24px; margin-right: 24px; @@ -66,9 +66,6 @@ img { border-bottom: 1px solid #606060; border-left: 1px solid #606060; border-right: 1px solid #606060; -} - -.banner, .header, .footer { margin-top: 24px; margin-bottom: 24px; } @@ -94,7 +91,15 @@ img { } .title { - font-size: 16pt; + background: #d7d7d7; + margin-left: 24px; + margin-right: 72px; + padding: 4px; + border-top: 1px solid #606060; + border-bottom: 1px solid #606060; + border-left: 1px solid #606060; + border-right: 1px solid #606060; + font-size: 14pt; } .subtitle { @@ -104,6 +109,7 @@ img { margin-top: 8px; margin-bottom: 8px; font-size: 12pt; + font-weight: bold; border-top: 1px solid #606060; border-bottom: 1px solid #606060; border-left: 1px solid #606060; @@ -191,6 +197,11 @@ img { text-align: right; } +.fixed { + font-family: "Courier New", "Courier", "fixed"; + font-size: 12pt; +} + .code { background: #f0f0f0; border-top: 1px solid #606060; 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> diff --git a/doc/style.css b/doc/style.css deleted file mode 100644 index 743e366..0000000 --- a/doc/style.css +++ /dev/null @@ -1,88 +0,0 @@ -/* - The Osirion Project - documentation stylesheet -*/ - -body { - color: #000000; - background-color: #ffffff; - font-size: 12pt; - margin: 32px; - border: 1px solid #000000; - padding: 16px; -} - -a { - color: #b38700; - text-decoration: none; -} - -a:hover { - text-decoration: none; - font-weight: bold; -} - -h1, h2, h3 { - margin-right: 32px; - width: auto; -} - -h1 { - margin-left: 16px; - margin-top: 32px; - font-size: 18pt; - border-bottom: 1px solid #000000; -} - -h2 { - margin-left: 32px; - margin-top: 32px; - font-size: 14pt; - border-bottom: 1px solid #000000; -} - -h2.navigate { - text-align: right; -} -h3 { - margin-left: 64px; - font-weight: bold; - font-size: 12pt; -} - -p, ul { - margin-left: 64px; - margin-right: 32px; - width: auto; -} - -table { - margin-left: 96px; - margin-right: 64px; -} - -td { - padding-right: 16px; - vertical-align: top; -} - -td.wide { - width: 156px; -} - -td.narrow { - width: 64px; -} -pre { - font-family: "Courier New", "Courier", "fixed"; - font-size: 14px; - margin-left: 64px; - margin-right: 64px; - width: auto; - background-color: #e5e5e5; - padding: 8px; - padding-left: 16px; -} -ul { - list-style-type: none; -}
\ No newline at end of file |