Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2008-07-14 20:41:12 +0000
committerStijn Buys <ingar@osirion.org>2008-07-14 20:41:12 +0000
commit61c081e77a8e445bb92bbda4fcbd8cfea707e6de (patch)
tree829e56e67e654f0c6db185c279f1f70e3f9ecb7b
parent28d7a4cd5b4bc3df5d034ed9472231d91710a6b6 (diff)
documentation updates
-rw-r--r--README7
-rw-r--r--doc/INSTALL155
-rw-r--r--doc/README301
-rw-r--r--doc/STORYLINE22
-rw-r--r--doc/index.html94
-rw-r--r--doc/installation.html37
-rw-r--r--doc/manual.html229
-rw-r--r--osirion.kdevelop14
-rw-r--r--osirion.kdevelop.pcsbin776291 -> 777061 bytes
-rw-r--r--osirion.kdevses19
10 files changed, 396 insertions, 482 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2f9bf43
--- /dev/null
+++ b/README
@@ -0,0 +1,7 @@
+
+The Osirion Project - README
+
+ The documentation for the Osirion project can be found in
+ the doc/ subdirectory.
+
+ Open doc/index.html in your favourite web browser.
diff --git a/doc/INSTALL b/doc/INSTALL
deleted file mode 100644
index 3f4bc75..0000000
--- a/doc/INSTALL
+++ /dev/null
@@ -1,155 +0,0 @@
-
-The Osirion Project - INSTALL
-
- These are the installation instructions for the Osirion Project.
- A description of the project and general usage information can be
- found in the README file.
-
-Installation
-
- To build the Osirion Project from source code you will need
- the following libraries and their header files:
-
- SDL version 1.2 or newer
- OpenGL, version 1.1 or newer
- OpenAL version 1.1 or newer
-
- I have succesfully compiled it on the following platforms:
-
- linux-x86_64 gcc 4.1.2
- linux-i686 gcc 4.1.2
- mingw32 gcc 4.2.2
-
- In theory, it should compile on any POSIX-compatible platform
- supported by SDL, reports for other platforms (working or not)
- are welcome.
-
-Compilation on windows32
-
- If you downloaded the zip file containing the windows32
- exe files, all the hard work has already been done and the
- game is ready to run. If you want to build your own exe files,
- keep on reading.
-
- You can use maci's excellent mingw/msys package to install
- a development environment on windows. You can find the
- installer here:
-
- http://satgnu.net/maci/files/q2wdevenv.exe
-
- You can use the Turtoisesvn SubVersion client to access the
- SVN repositories. You can download it from
-
- http://tortoisesvn.tigris.org/
-
-Obtaining the source code
-
- Get the latest version of the source code from svn:
-
- svn checkout svn://intranifty.no-ip.org/osirion
-
- This command will create a new subdirectory 'osirion'
- and download the source code into it.
-
-Compiling the source code
-
- Enter the new directory and compile the source code:
-
- cd osirion/
- autoreconf -fi
- ./configure
- make
-
- If you only need to compile the dedicated server, you can
- pass the --without-client option to configure:
-
- ./configure --without-client
-
- At present, 'make install' is neither tested nor supported.
-
-Installing game data
-
- The game data should be located in the 'data'
- subdirectory of the main distribution.
-
- Get the latest version of the game data from svn:
- Run the following command from within the main
- distribution directory:
-
- svn checkout svn://intranifty.no-ip.org/osirion-data data
-
-Installing gtkradiant 1.5.0 support files (optional)
-
- You only need to install these files if you want to create models
- with gtkradiant. Note that these files where made for
- gtkradiant 1.5.0, I have not tested the with any other version.
- You can find precompiled gtkradiant 1.5.0 binaries for linux at
- http://ingar.soliter.org.
-
- These instructions assume gtkradiant is installed in the directory
- '/usr/local/games/gtkradiant-1.5.0'. If it is installed in a different
- directory on your system, edit these instructions accordingly.
-
- Copy the support files to the gtkradiant folder:
-
- cd data
- cd gtkradiant
- cp -vr * /usr/local/games/gtkradiant-1.5.0
-
- Open the file '/usr/local/games/gtkradiant-1.5.0/games/osirion.game' in
- your favourite editor. Look for a line that begins with:
-
- enginepath_linux="
-
- Make sure it points to your osirion data directory. For example,
- if you checked out the source code in '/home/user/games/osirion',
- then the data will be in '/home/user/games/osirion/data' and
- the line should look like this:
-
- enginepath_linux="/home/user/games/osirion/data"
-
- Save the changes.
-
-Source data (optional)
-
- The .xcf and .svg source files used to create the game data
- can also be downloaded. Note that you do not need these files
- to play the game or to create .map models. You only have to
- download them them if you want to create new game graphics.
-
- To download the source data:
-
- svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
-
-Executing
-
- To run the client program, execute:
-
- src/osirion
-
- To run the dedicated server, execute:
-
- src/osiriond
-
-Updating
-
- If you downloaded and compiled the game before,
- there is no need to re-download the entire distribution.
-
- Update the game source code with the following commands:
-
- cd osirion/
- make distclean
- svn update
-
- Rebuild the game:
-
- autoreconf -fi
- ./configure
- make
-
- Update the game data:
-
- cd data/
- svn update
- cd ..
diff --git a/doc/README b/doc/README
deleted file mode 100644
index b233c77..0000000
--- a/doc/README
+++ /dev/null
@@ -1,301 +0,0 @@
-
-The Osirion Project - README
-
- This is the Osirion project. I wrote it to get a better grasp on
- game design with OpenGL and to get some C++ practice.
- Maybe someday it will be a real game.
-
- Read INSTALL for instructions on building, installing and updating.
-
-Client
-
- Starting the client will show the loader screen.
- To start the game, open the client console with ~ and type 'connect'.
- 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.
-
- The client is capable of acting as a networked server. You can enable
- the private server by setting 'sv_private 1' before you 'connect'.
- This wil allow remote players to connect to your client.
-
- To connect to a dedicated server, type 'connect address', where
- adress is the hostname or IP address of the remote server.
-
- In-game, you can purchase a new ship with the 'buy' command.
-
-Keyboard
-
- 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.
-
- To bind the keypad left key to the turn left action:
-
- bind kpleft +left
-
- To bind the P key to the screenshot command:
-
- 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
- available key names.
-
- The default configuration:
-
- ~ toggle console
- V switch between track, cockpit and free view
- space bar turn mouse control on or off
- left right up down arrow
- rotate camera in free view
- keypad left right up down
- steer the ship left/right/up/down
- keypad / * roll left/right
- keypad + - increase/decrease forward thruster
- T open the chat window
- print screen screenshot
-
-Mouse
-
- If mouse control is on, you can use it to steer your vessel
- in track or cockpit view, or to rotate the camera in free view.
-
- If mouse control is disabled, you can temporarily enable it again
- by pressing the left mouse button.
-
- Use the scroll wheel to increase/decrease thruster.
-
- Mouse buttons can also be configured through the 'bind' command.
-
-Console functions
-
- The following commands are always available on the console:
-
- connect connect the client to the game module
- disconnect disconnect the client from the game module
- list_ent list registered entities
- list_func list registered functions
- list_model list registered models
- list_var list registered variables
- quit exit the application
- r_restart restart the video subsystem
-
- The following commands are available when connected to a game:
-
- join join the game
- spectate spectate
- buy purchase a new ship
- who list connected players
-
- 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:
-
- r_width 1024
- r_height 768
- r_restart
-
- To switch to fullscreen mode, set the r_fullscreen
- variable to 1:
-
- r_fullscreen 1
- r_restart
-
- 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.
-
- cl_name SpaceCowboy
- cl_color 1.0 1.0 0.0
- connect
-
-Statistics
-
- To activate statistics, set the draw_stats variable to 1:
-
- draw_stats 1
-
- This will draw the following statistics on the right side
- of the screen:
-
- fps frames per second
- tris number of triangles drawn
- quads number of quads drawn
- tx network upstream traffic, in kilobytes
- rx network downstream traffic, in kilobyte
-
- The fps counter will not show values above 9999.
-
-Configuration
-
- Variables marked with the 'A' flag will be archived, their value
- will be written to the configuration file on exit. The dedicated
- server reads its configuration from server.cfg, the client
- will use client.cfg. Keyboard binds will be saved to binds.cfg
-
- On UNIX systems you can find these files in the ~/.osirion/base
- directory.
-
- 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 os 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 setting to
- the server's actual IP address. The default listening port can
- be altered by changing the net_port setting.
-
-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:
-
- src/osirion +connect remote.server.org
-
- To start a client and create a new network game:
-
- src/osirion +set sv_private 1 +connect +join
-
- To start a dedicated server and set the server framerate to 30 frames per
- second:
-
- src/osiriond +set sv_framerate 30
-
- Note:
-
- Setting variable values 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 windows32 users
-
- On windows32, the game uses the 'home' subdirectory as your personal
- directory. For example, the client.ini can be found in
- home\base\client.ini.
-
- There is also a problem that prevents the game from creating directories.
- If you need any subdirectories in your personal folder, like 'screenshots',
- you will have to create it manually.
-
-Organization of the distribution
-
- C++ source code
-
- /src
- README this file
- INSTALL documentation in installation
- MODELS documentation on creating models
-
- /math mathematical classes
- /sys low-level system functions
- /filesystem virtual filesystem library
- /core game-independent core library
- /game game-specific functions
- /server osiriond dedicated server
- /render render library
- /client osirion client
-
- Data files
-
- /data
- /base game data files
- /bitmaps essential bitmaps
- /ini ini files
- /maps .map models
- /satellites sattelites
- /ships spaceships
- /stations space stations
- /scripts gtkradiant shader files
- /textures textures
- /gtkradiant gtkradiant support files
-
- The game data can be obtained as a seperate distribution.
- Refer to the file INSTALLATION for more information.
-
-Editing game data
-
- One of the goals of the Osirion Project, is to create an engine
- that makes it very easy to adapt and extend the game world.
- At the moment, the game reads the world description from
- ini/world.ini and a list of buyable ships from ini/ships.ini.
-
- I recommend you do not edit the original game data, but to make a copy
- into your personal osirion folder '~/.osirion'. This directory mimics
- the directory structure of the 'data' directory and any file found
- there will get precedence over the corresponding file in
- the game data directory.
-
- The models are basic Quake2 style .map files with custom entities
- and can be created with a program like gtkradiant. Refer to the
- file MODELS for more information on creating 3D models.
-
-Project contributors
-
- [mDc]Thorn - Technical advisor, Sharkan model, Horizon model,
- Alpha testing
-
- Supertanker - Station 15 model, Supertanker model, Avatar model
- Bumblebee model
-
- Josky=KCT= - Shuttle model, alpha testing
-
- [mDc]Minisori
- Gareth - Alpha testing
- DVSoftware
-
-IRC
-
- The official Osirion IRC channel is #osirion on irc.soliter.org
-
-Web
-
- Screenshots can be found at
- http://ingar.satgnu.net/osirion
-
-Acknowledgements
-
- This project could not have been possible without the work of others:
-
- Id Software
-
- the GtkRadiant project contributers
-
- The Quake2World community
-
- The Satgnu crew
-
- Thanks to bobke and blaze-x
-
- DVSoftware for bandwidth, diskpace and CPU power
-
- A special thanks to all =KCT= members
-
-License
-
- The Osirion Project is distributed under
- the terms and conditions of
- the GNU General Public License version 2.
-
- This includes the source code, project documentation and game data.
-
- Copyright 2007-2008
- Ingar=KCT= <ingar@telenet.be>
-
- Contact me if you want to use (portions of) this project
- under a non-compatible, but otherwise free, licence.
-
-Trademarks
-
- QUAKE and ID are registered trademarks of Id Software, Inc.
- LEGO is a registered trademark of the LEGO Group.
-
- The Osirion Project is an independent not-for-profit project
- and is not affiliated with these companies.
-
diff --git a/doc/STORYLINE b/doc/STORYLINE
index 87adfb9..280b443 100644
--- a/doc/STORYLINE
+++ b/doc/STORYLINE
@@ -9,6 +9,28 @@ PLACES
Planet Seymour, Regula Station
Planet Ghant, Alexandria Outpost
+Planet Lindblade
+
+*
+
+PLANET GHANT
+
+Alexandria outpost
+
+Battleship Custodian
+
+
+PLANET SEYMOUR
+
+Regula station
+
+*
+
+PLANET CLEARHAVEN
+
+*
+
+PLANET LUCIA
ITEMS
diff --git a/doc/index.html b/doc/index.html
index 2b8fa14..82a2fac 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -5,8 +5,6 @@
<link rel="stylesheet" type="text/css" href="style.css">
<TITLE>The Osirion Project</TITLE>
</head>
-<body>
-
<H1>
The Osirion Project
</H1>
@@ -48,9 +46,14 @@
<ul>
<li><a href="installation.html">Installation</a>
- <li>Player manual
- <li>Administrator manual
- <li>Developer manual
+ <li><a href="manual.html">User manual</a>
+ </ul>
+ <ul>
+ <li>Editing the world
+ <li>Creating models
+ </ul>
+ <ul>
+ <li>Developer section
</ul>
<ul>
<LI><a href="license.html">License</a>
@@ -58,17 +61,82 @@
</p>
<h2>
- Copyright
+ Project contributors
</h2>
+<p>
+ <table><TR>
+ <td>Ingar=KCT=</td>
+ <td>Project lead, programming, models, graphics</td></tr>
+
+ <td>[mDc]Thorn</td>
+ <td>Technical advisor, Sharkan model, Horizon model, alpha testing
+ </td></tr>
+
+ <td>Supertanker</td>
+ <td>Station 15 model, Supertanker model, Avatar model, Bumblebee model
+ </td></tr>
+ <td>Josky=KCT=</td>
+ <td>Shuttle model, alpha testing
+ </td></tr>
+
+ <td>[mDc]Minisori<br>
+ Gareth<br>
+ DVSoftware
+ </td><td>
+ alpha testing
+ </td></tr>
+ </table>
+<h2>
+ Website
+</h2>
<p>
- The Osirion Project source code and related files, and the Project::OSiRiON game data
- are distributed under the terms and conditions of the
- <a href="license.html">GNU General Public license, version 2</a>.
-</p>
+ The website for the osirion project can be found at:<br>
+ <a href="http://ingar.satgnu.net/osirion">http://ingar.satgnu.net/osirion</a>
+<h2>
+ IRC
+</h2>
<p>
- Copyright &copy; 2007-2008, Stijn "Ingar" Buys <ingar@telenet.be>
-</p>
-
+ The official Osirion IRC channel is #osirion on irc.soliter.org
+<h2>
+ Acknowledgements
+</h2>
+<p>
+ This project could not have been possible without the work of others:
+ <ul>
+ <li>Id Software
+ <li>the GtkRadiant project contributers
+ <li>The Quake2World community
+ <li>The Satgnu crew
+ <li>maci, for the webspace on satgnu
+ <li>DVSoftware for bandwidth, diskpace and CPU power
+ <li>NASA for their collection of freely available images
+ <li>Thanks to bobke and blaze-x
+ <li>A special thanks to all =KCT= members
+ </ul>
+<h2>
+ License
+</h2>
+<p>
+ The Osirion Project source code, the Project::OSiRiON game data
+ and related files are distributed under the terms and conditions of the
+ <a href="license.html">GNU General Public License version 2</a>.
+<p>
+ This includes the source code, project documentation and game data.
+<p>
+ Copyright &copy; 2007-2008<br>
+ Stijn "Ingar" Buys &lt;ingar@telenet.be&gt;
+<p>
+ Contact me if you want to use (portions of) this project
+ under a non-compatible, but otherwise free, licence.
+<h2>
+ Trademarks
+</h2>
+<p>
+ QUAKE and ID are registered trademarks of Id Software, Inc.<br>
+ LEGO is a registered trademark of the LEGO Group.
+<p>
+ The Osirion Project is an independent not-for-profit project
+ and is not affiliated with these companies.
</body>
</html> \ No newline at end of file
diff --git a/doc/installation.html b/doc/installation.html
index 275da58..920c970 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -9,7 +9,7 @@
<body>
<h1>
- Installation
+ The Osirion Project - Installation
</h1>
<p>
These are the installation instructions for the Osirion Project.
@@ -257,4 +257,39 @@ enginepath_linux="/home/user/games/osirion/data"
<pre>
svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
</pre>
+<h2 id="organization">
+Organization of the distribution
+</h2>
+<pre>
+/doc Documentation
+
+ index.html Documentation content
+ installation.html Installation instructions (this file)
+ license.html Copyright license
+
+/src C++ source code
+
+ /math mathematical classes and functions
+ /sys low-level system functions
+ /filesystem filesystem library
+ /auxiliary auxiliary functions
+ /core game-independent core library
+ /game game-specific functions
+ /server osiriond dedicated server
+ /render render library
+ /audio audio library
+ /client osirion client
+
+/data Data files
+
+ /base game data files
+
+ /bitmaps essential bitmaps
+ /ini game world description files
+ /maps game world models
+ /scripts gtkradiant shader files
+ /textures game world textures
+
+ /gtkradiant gtkradiant support files
+</pre>
</html>
diff --git a/doc/manual.html b/doc/manual.html
new file mode 100644
index 0000000..aab5542
--- /dev/null
+++ b/doc/manual.html
@@ -0,0 +1,229 @@
+<!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>
+<H1>
+ The Osirion Project - User manual
+</H1>
+
+<h2>
+ Client
+</h2>
+<p>
+ Starting the client will show the loader screen.
+ To start the game, open the client console with the ~ key and type <i>connect</i>.
+ 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 'list_keys' command to get a list of all
+ available key names.
+<p>
+ The default configuration:
+<table>
+ <tr><td>~
+ </td><td>toggle console
+ </td></tr>
+
+ <tr><td>V
+ </td><td>switch between track, cockpit and free view
+ </td></tr>
+
+ <tr><td>space bar
+ </td><td>toggle mouse control on or off
+ </td></tr>
+
+ <tr><td>left right up down arrow
+ </td><td>rotate camera in free view
+ </td></tr>
+
+ <tr><td>keypad left right up down
+ </td><td>steer the ship left/right/up/down
+ </td></tr>
+
+ <tr><td>keypad / *
+ </td><td>roll left/right
+ </td></tr>
+
+ <tr><td>keypad + -
+ </td><td>increase/decrease forward thruster
+ </td></tr>
+
+ <tr><td>T
+ </td><td>open the chat window
+ </td></tr>
+
+ <tr><td>print screen
+ </td><td>screenshot
+ </td></tr>
+<table>
+<h2>
+ Mouse
+</h2>
+<p>
+ If mouse control is on, you can use it to steer your vessel
+ in track or cockpit view, or to rotate the camera in free view.
+<p>
+ If mouse control is disabled, you can temporarily enable it again
+ 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>
+Console functions
+</h2>
+<p>
+ The following commands are always available on the console:
+<table>
+ <tr><td>connect </td><td>connect the client to the game module</td></tr>
+ <tr><td>disconnect </td><td>disconnect the client from the game module</td></tr>
+ <tr><td>list_ent </td><td>list registered entities</td></tr>
+ <tr><td>list_func </td><td>list registered functions</td></tr>
+ <tr><td>list_model </td><td>list registered models</td></tr>
+ <tr><td>list_var </td><td>list registered variables</td></tr>
+ <tr><td>quit </td><td>exit the application</td></tr>
+ <tr><td>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>join </td><td>join the game</td></tr>
+ <tr><td>spectate </td><td>spectate</td></tr>
+ <tr><td>buy </td><td>purchase a new ship</td></tr>
+ <tr><td>who </td><td>list connected players</td></tr>
+</table>
+<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></p>
+ To switch to fullscreen mode, set the r_fullscreen
+ variable to 1:
+<pre>
+r_fullscreen 1
+r_restart
+</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:
+
+ fps frames per second
+ tris number of triangles drawn
+ quads number of quads drawn
+ tx network upstream traffic, in kilobytes
+ rx network downstream traffic, in kilobyte
+<p>
+ The fps counter will not show values above 9999.
+<h2>
+ Configuration
+</h2>
+<p>
+ Variables marked with the 'A' flag will be archived, their value
+ will be written to the configuration file on exit. The dedicated
+ server reads its configuration from server.cfg, the client
+ will use client.cfg. Keyboard binds will be saved to binds.cfg
+<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 os 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 framerate to 30 frames per
+ second:
+<pre>
+osiriond +set sv_framerate 30
+</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 windows32 users
+</h2>
+<p>
+ On windows32, the game uses the <i>home</i> subdirectory as your personal
+ directory. For example, the client.ini can be found as <i>home\base\client.ini</i>.
+<p>
+ There is also a problem that prevents the game from creating directories.
+ If you need any subdirectories in your personal folder, like <i>screenshots</i>,
+ you will have to create it manually.
diff --git a/osirion.kdevelop b/osirion.kdevelop
index 599b8d8..25d8c79 100644
--- a/osirion.kdevelop
+++ b/osirion.kdevelop
@@ -16,7 +16,7 @@
<projectdirectory>./</projectdirectory>
<absoluteprojectpath>false</absoluteprojectpath>
<description>The OSiRiON Project is an SDL+OpenGL space game.</description>
- <defaultencoding></defaultencoding>
+ <defaultencoding/>
<versioncontrol>kdevsubversion</versioncontrol>
</general>
<kdevautoproject>
@@ -196,7 +196,7 @@
<designerpluginpaths/>
</qt>
<creategettersetter>
- <prefixGet></prefixGet>
+ <prefixGet/>
<prefixSet>set</prefixSet>
<prefixVariable>m_,_</prefixVariable>
<parameterName>theValue</parameterName>
@@ -228,11 +228,11 @@
</cppsupportpart>
<kdevdebugger>
<general>
- <gdbpath></gdbpath>
- <dbgshell></dbgshell>
- <configGdbScript></configGdbScript>
- <runShellScript></runShellScript>
- <runGdbScript></runGdbScript>
+ <gdbpath/>
+ <dbgshell/>
+ <configGdbScript/>
+ <runShellScript/>
+ <runGdbScript/>
<breakonloadinglibs>true</breakonloadinglibs>
<separatetty>false</separatetty>
<floatingtoolbar>false</floatingtoolbar>
diff --git a/osirion.kdevelop.pcs b/osirion.kdevelop.pcs
index 3e74a85..a0cddae 100644
--- a/osirion.kdevelop.pcs
+++ b/osirion.kdevelop.pcs
Binary files differ
diff --git a/osirion.kdevses b/osirion.kdevses
index 11b0116..f5527b0 100644
--- a/osirion.kdevses
+++ b/osirion.kdevses
@@ -1,13 +1,22 @@
<?xml version = '1.0' encoding = 'UTF-8'?>
<!DOCTYPE KDevPrjSession>
<KDevPrjSession>
- <DocsAndViews NumberOfDocuments="2" >
- <Doc0 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/client/input.cc" >
- <View0 Encoding="" line="437" Type="Source" />
+ <DocsAndViews NumberOfDocuments="5" >
+ <Doc0 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/audio/audio.cc" >
+ <View0 Encoding="" line="85" Type="Source" />
</Doc0>
- <Doc1 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/game/game.cc" >
- <View0 Encoding="" line="72" Type="Source" />
+ <Doc1 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/audio/buffers.cc" >
+ <View0 Encoding="" line="106" Type="Source" />
</Doc1>
+ <Doc2 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/audio/sources.cc" >
+ <View0 Encoding="" line="46" Type="Source" />
+ </Doc2>
+ <Doc3 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/audio/sources.h" >
+ <View0 Encoding="" line="28" Type="Source" />
+ </Doc3>
+ <Doc4 NumberOfViews="1" URL="file:///home/ingar/projects/osirion/osirion-work/src/audio/buffers.h" >
+ <View0 Encoding="" line="35" Type="Source" />
+ </Doc4>
</DocsAndViews>
<pluginList>
<kdevdebugger>