Project::OSiRiON - User manual

When the client has started it will show you the main menu. Click the - Start button to start a game, or click the Internet + Start button to start a game, or click the Internet button to connect to the test server.

- The Options button will open the options menu where you can + The Options button will open the options menu where you can customize a number of settings.

When the game has started it will show you the game menu. Click the - Join button to join the game, or click the Disconnect + Join button to join the game, or click the Disconnect button to leave the game and return to the main menu.

Later on, you can press f1 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.

Click the Launch icon on the top of the screen to launch into space. +

Click the Launch icon on the top of the screen to launch into space.

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: - tracking view, the default mode, cockpit view and free view. + track, the default mode, cockpit and free.

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

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 - D:\Osirion then there should be a directory D:\Osirion\data\base containing the + D:\Osirion then there should be a directory D:\Osirion\data\base containing the game data.

- Open the game directory in explorer and click on osirion.exe to start the client. + Open the game directory in explorer and click on osirion.exe to start the client.

@@ -190,7 +190,7 @@ sudo make install

On linux, you can use the Subversion command line client tool. The following - command will create a new subdirectory osirion and download the source code into it. + command will create a new subdirectory osirion and download the source code into it.

svn co svn://intranifty.no-ip.org/osirion osirion @@ -224,28 +224,26 @@ autoreconf -fi

If you do not need the client and want to build the dedicated server only - you can pass the --without-client option to configure: + you can pass the --without-client option to configure:

- Configure will automaticly detect the bullet library if itwass installed in /usr/local. - If it was installed somewhere else you will have to pass the --with-bullet=directory option - to configure. -

- For example, if you want to use the system-provided package on Arch linux, use - --with-bullet=/usr. + Configure will automaticly detect the bullet library if it was installed in /usr/local. + If it was installed somewhere else you will have to pass the --with-bullet=directory option + to configure. For example, --with-bullet=/usr will use the bullet libraries installed in + /usr/lib and the includes in /usr/include/bullet. +

./configure --without-client

- If configure finds ncurses or pdcurses, the dedicated server will use this + If configure finds ncurses or pdcurses, the dedicated server will use this library and a have a curses console. To disable curses detection, pass the - --without-curses option to configure. + --without-curses option to configure.

- Important: make install is not supported. Results are unpredictable. + Important: make install is not supported. Results are unpredictable.

Compile the source code: @@ -254,7 +252,7 @@ autoreconf -fi
make

- The binaries will be build in the src subdirectory of the main distribution. + The binaries will be build in the src subdirectory of the main distribution.

- The game data should be located in the data subdirectory of the main distribution. + The game data should be located in the data subdirectory of the main distribution. You can use the game data package from the website or get it from the osirion-data subversion repository:

svn://intranifty.no-ip.org/osirion-data @@ -271,7 +269,7 @@ make

Run the following command from within the main distribution directory to download - the game data into the data subdirectory: + the game data into the data subdirectory:

svn checkout svn://intranifty.no-ip.org/osirion-data data @@ -284,9 +282,9 @@ svn checkout svn://intranifty.no-ip.org/osirion-data data

- The client and the dedicated server will look for game data in the data subdirectory - of the current working directory. Since the binaries are build in the src you will - have start them with the src/ prefix. + The client and the dedicated server will look for game data in the data subdirectory + of the current working directory. Since the binaries are build in the src you will + have start them with the src/ prefix.

To start the client: @@ -305,7 +303,7 @@ src/osirion src/osiriond

- If you are using windows, the binaries will be called osirion.exe and osiriond.exe. + If you are using windows, the binaries will be called osirion.exe and osiriond.exe.

These instructions assume gtkradiant is installed in the directory - /usr/local/games/netradiant. If it is installed in a different + /usr/local/games/netradiant. If it is installed in a different directory on your system, edit these instructions accordingly.

Copy the support files to the gtkradiant folder: @@ -365,20 +363,20 @@ cd gtkradiant
cp -vr * /usr/local/games/netradiant

- Open the file /usr/local/games/netradiant/games/osirion.game in + Open the file /usr/local/games/netradiant/games/osirion.game in your favourite editor. Look for a line that begins with:

Make sure it points to your osirion data directory. For example, - if you checked out the source code in /home/yourname/osirion, - then the data will be in /home/yourname/osirion/data and + if you checked out the source code into /home/user/osirion, + then the data will be in /home/user/osirion/data and the line should look like this:

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

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

+ +

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

+ TODO Concerning commands +

+ TODO Concerning command line options +

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

+

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

+

The following commands are always available on the console: @@ -194,14 +339,18 @@ Console functions
who list 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. -

+

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

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

+

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

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

- Project::OSiRiON - User manual -

+

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

+

+

+ + Statistics -

- Configuration files -

+

+ be altered by changing the net_port variable. +

- Note for windows users -

- back -

+ +
Statistics -