From 634b12e329b0e1e305490c6bc87ce414fd027add Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Mon, 23 Feb 2009 18:31:03 +0000 Subject: major documentation update --- doc/attributions.html | 49 ++++++-- doc/guide.html | 111 ++++++++++++----- doc/images/banner.jpg | Bin 0 -> 8480 bytes doc/images/banner.png | Bin 0 -> 3511 bytes doc/images/main_menu.jpg | Bin 0 -> 9204 bytes doc/index.html | 148 +++++++++++----------- doc/installation.html | 312 ++++++++++++++++++++++++++++------------------- doc/keys/f1.png | Bin 0 -> 422 bytes doc/keys/f6.png | Bin 0 -> 465 bytes doc/keys/tilde.png | Bin 0 -> 398 bytes doc/keys/v.png | Bin 0 -> 513 bytes doc/main.css | 222 +++++++++++++++++++++++++++++++++ 12 files changed, 603 insertions(+), 239 deletions(-) create mode 100644 doc/images/banner.jpg create mode 100644 doc/images/banner.png create mode 100644 doc/images/main_menu.jpg create mode 100644 doc/keys/f1.png create mode 100644 doc/keys/f6.png create mode 100644 doc/keys/tilde.png create mode 100644 doc/keys/v.png create mode 100644 doc/main.css (limited to 'doc') diff --git a/doc/attributions.html b/doc/attributions.html index b8a7cad..5cb365b 100644 --- a/doc/attributions.html +++ b/doc/attributions.html @@ -1,32 +1,43 @@ - + - - The Osirion Project - Attributions + + Project::OSiRiON - Attributions -

- The Osirion Project - Attributions -

+ + +

- The Project::OSiRiON game data is distributed under the terms and conditions + The game data is distributed under the terms and conditions of the Create Commons Attribution-Share Alike 3.0 License. +

Files by nathanshadow are distributed under the terms of the Creative Commons Sampling Plus 1.0 license. +

Files by NASA are in the public domain. - -

+

+

+ +
Contributions - +
+

These files were contributed to the project: +

+

@@ -191,13 +202,21 @@
directory
+
+ +

-

+

+ +
Derived works - +
+

These files are available on the internet or are based on freely available works: +

+

@@ -267,7 +286,11 @@
directory
- +
+ +

+
+ diff --git a/doc/guide.html b/doc/guide.html index 75156f2..021f61f 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1,61 +1,106 @@ - + - - The Osirion Project - Player guide + + Project::OSiRiON - Player Guide - -

- The Osirion Project - Player guide -

+ +

OK Space Cadets, prepare to hurtle through the Cosmos!

So, you have decided to leave your old life behind and explore the universe - of Project::OSiRiON? This guide will show you how to take your first steps + of Project::OSiRiON. This guide will show you how to take your first steps and teach you the basic skills you need to survive these new surroundings.

Before you can be allowed to pilot a space ship, make sure you have reviewed the installation instructions to ensure - a smooth operation of the onboard computer systems. Advanced topics - are covered by the user manual. + optimal performance of the onboard computer systems. Advanced topics + and server operations are covered by the user manual.

+
-

- User Interface -

- -

- HUD -

+
+ Getting Started +
-

- Fligh controls -

- -

- Keyboard -

+
+
+

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

+

+ The Options button will open the options menu where you can + customize your settings. +

- This is the default keyboard configuration: + When the game has started it will show you the game menu. Click the + 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 the F1 key to return to the game menu. +

+

+ You can press the ~ key at any time to open the command console. +

+ Once you have joined, you will find yourself on Alexandria, + a small trading outpost at 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. +

+
-

- Joystick -

+
+ Controls +
+ +
+ Camera +
+ +

- This is the default joystick configuration: + 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. +

+ Press the V key to switch to the next view. +

+ Press shift + V to switch to the previous view. +

+ Press keypad / to zoom in. +

+ Press keypad * to zoom out. +

+ Zoom is disabled in cockpit view. +

+ Mouse control is enabled by default. If the camera is in tracking or cockpit view then the + mouse will control your spaceship's movement, in free view the mouse will rotate the camera. +

+ Press spacebar to toggle mouse control on or off. + If mouse control is disabled, you can activate it by clicking and holding down the left mouse button.

+
+ +
+ Flight Controls +
-

- back -

+
+ Navigation Controls +
- \ No newline at end of file + diff --git a/doc/images/banner.jpg b/doc/images/banner.jpg new file mode 100644 index 0000000..067e5e7 Binary files /dev/null and b/doc/images/banner.jpg differ diff --git a/doc/images/banner.png b/doc/images/banner.png new file mode 100644 index 0000000..c702afa Binary files /dev/null and b/doc/images/banner.png differ diff --git a/doc/images/main_menu.jpg b/doc/images/main_menu.jpg new file mode 100644 index 0000000..43cbd82 Binary files /dev/null and b/doc/images/main_menu.jpg differ diff --git a/doc/index.html b/doc/index.html index 1c7f693..af9e3d3 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,84 +1,92 @@ - + - - The Osirion Project + + Project::OSiRiON - Documentation -

- The Osirion Project -

+ + + + +

- The Osirion project is a game engine in the early stages of development. - It's written in C++ and uses SDL, OpenGL, OpenAL and zlib. - With this project I want to gain some insight in these technologies - and game development in general. -

- The Quake family of game engines served as an example for the general - structure of the engine, the in-game console and the filesystem hierarchy - should look familiar to many players. -

- The goal is to create an engine that uses common file formats and a game world that is easy to edit. - In other words, you should not have to be a rocket scientist to create something yourself. - World data is loaded from plain text .ini files, object models are loaded from quake2-style .map files. - Support files for GtkRadiant 1.5 are included with the game data. + Project::OSiRiON is a 3D space exploration game under development. It aims to offer + gameplay inspired by games like Privateer and Freelancer.

-

- Project::OSiRiON -

- Project::OSiRiON is the name of the game that uses the Osirion Project engine. - The game is located in a still unnamed region of space with gameplay inspired - by games like Freelancer and - Privateer. -

- Right now the game world is a rather large sandbox. You can fly around in - different ships and explore the solar system, but important features - like weapons, docking and collision detection are not yet implemented. + The basic components are already in place: the game supports network multiplayer, + an ingame command console, 3D models in a GtkRadiant 1.5 compatible .map format and a flat-color + renderer that should provide an acceptable framerate, even on older systems. +

+

+ All game world data is loaded from easy to edit text files and each server can + offer its own customized game world.

+

+ The main gameplay elements have not yet been implemented: players are able to purchase new ships and + visit many places across the galaxy, but important features like collision detection, + weapons and cargo are still missing. +

+

+ The engine is written in C++ and uses portable libraries like SDL, OpenGL, OpenAL and zlib. + Both linux and windows versions are supported but it probably compiles on most systems + supported by gcc and SDL. +

+
-

+
Content -

+ +

+

+
-

- Project contributors -

+
+ Project Contributors +
+
- + + + + - - - - - @@ -90,44 +98,48 @@ Alpha testing
Ingar=KCT=Game design, programming, modelling, graphics, sounds + Project head, programming, modelling, graphics, sounds, world
OdinModelling, graphics, world
[mDc]ThornDesign advice, modelling, graphics + Design advice, graphics, modelling
Supertanker Modelling
OdinModelling
Josky=KCT= Design advice
+
-

- Website -

+
+ Internet +
+

- The website for the osirion project can be found at + The website for Project::OSiRiON can be found at http://ingar.satgnu.net/osirion

- -

- IRC -

- The official Osirion IRC channel is #osirion on irc.soliter.org + The official Osirion IRC channel is #osirion on irc.soliter.org.

+
-

+

+ +

- The Osirion Project source code is distributed under the terms and conditions of the + The source code is distributed under the terms and conditions of the GNU General Public License. -

- The Project::OSiRiON game data is distributed under the terms and conditions - of the Create Commons Attribution-Share Alike 3.0 License.
- However, a few files are distributed under the terms of a different license. +

+

+ The game data is distributed under the terms and conditions of the + Create Commons Attribution-Share Alike 3.0 License.
+

+

+ A few files are distributed under the terms of a different license. Please read the list of attributions for a complete overview of authors and copyright. +

Copyright © 2007-2008
Stijn "Ingar" Buys <ingar@telenet.be> -

- Contact me if you want to use (portions of) this project - under a non-compatible, but otherwise free, licence. +

+
-

+
Acknowledgements -

+ +

This project could not have been possible without the work of others:

- -

- 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 + Project::OSiRiON is an independent, not-for-profit project and is not affiliated with these companies.

diff --git a/doc/installation.html b/doc/installation.html index 10ae6c5..7da1b59 100644 --- a/doc/installation.html +++ b/doc/installation.html @@ -1,40 +1,50 @@ - - + - - The Osirion Project - Installation + + Project::OSiRiON - Installation Instructions + + -

- The Osirion Project - Installation -

+

- These are the installation instructions for the Osirion Project. There are two ways to install the program and the game data. You can - either download a precompiled package from the website, or you + either download a package from the website, or you can obtain the source code and compile it yourself.

-

- Using precompiled executables -

-

- You can find the latest version in the download section of the website:
- http://ingar.satgnu.net/osirion/files -

+

+ +
+ Using packages +
+
+

+ You can find the latest version in the downloads section of the website:
+ http://ingar.satgnu.net/osirion +

+
+ +
Windows - +
+ +

- Download the windows executables package:
+ Download the windows package:
osirion-win32-latest.zip
- This packages contains the win32 version of the server and the client. + This package contains the win32 version of the server and the client.

Dowload the game data package:
osirion-data-latest.zip
@@ -45,52 +55,68 @@ game data.

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

+

+ +
Linux - +
+ +
+

- Download the linux executables packages:
+ Download the linux packages:
osirion-linux-latest.zip
- This packages contains the linux x86 and x86_64 versions of the client and the server. + This package contains the linux 32 and 64 bit versions of the client and the server.

Extract the package, a new subdirectory will be created. The actual directory name will depend on the version number. Enter the new subdirectory. -

-tar jxvf osirion-latest.tar.bz2
+

+tar jxvf osirion-latest.tar.bz2

 cd osirion-0.1_258-linux
-
+

Dowload the game data package:
osirion-data-latest.zip

Unzip it: -

+

 unzip ../osirion-data-latest.zip
-
+

- To run the 32bit client: -

+	 To run the 32 bit client:
+

 ./osirion.x86
-
+

- To run the 64bit client: -

+	 To run the 64 bit client:
+

 ./osirion.x86_64
-
-

+ + + + +
Building from source code -

-

- Requirements -

+ + +

To build The Osirion Project from source code you will need to have - the following libraries and their header files installed on your system. + the following libraries and development packages installed on your system. +

+
+
+ Requirements +
+ +

+ To build the client or the dedicated server:

+

To build the client:

+

You will also need a recent version of gcc, GNU make, automake and libtool. -

In theory, the source should compile on any POSIX-compatible platform - supported by SDL, reports for other platforms (working or not) - are welcome. I have succesfully compiled it myself on the following platforms: -

-

- Obtaining the source code -

+ supported by SDL. +

+
+ +
+ Obtaining the source code +
+

You can get the osirion project source code from the subversion repository:
svn://intranifty.no-ip.org/osirion +

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

+

+

 svn co svn://intranifty.no-ip.org/osirion osirion
-
+

On windows, you can use the Turtoisesvn SubVersion client to access the SVN repositories. You can download it here:
- http://tortoisesvn.tigris.org/ + http://tortoisesvn.tigris.org +

- You can also get the source package from the website:
+ You can also download the source package from the website:
osirion-src-latest.tar.bz2 -

- Compiling the source code -

+

+ + +
+ Compiling the source code +
+

Enter the new directory and configure the source code: -

-cd osirion
-autoreconf -fi
-./configure
-
+
+cd osirion
+autoreconf -fi
+./configure
+
+

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

+

+

 ./configure --without-client
-
+

- If configure finds the ncurses library, the server will be build - with an ncurses console. To disable ncurses detection, pass the - --without-ncurses option to configure. + 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. +

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

Compile the source code: -

+

+

 make
-
+

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

- Obtaining the game data -

+

+ + +
+ Obtaining the game data +
+

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 +

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

+

+

 svn checkout svn://intranifty.no-ip.org/osirion-data data
-
- -

- Executing -

+
+ + + +
+ Executing +
+

- The client and the dedicated server look for the game data in the data subdirectory + 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 to copy them with the src/ prefix. +

- To start the client -

+	To start the client:
+

+

 src/osirion
-
+

- To start the dedicated server -

+	To start the dedicated server:
+

+

 src/osiriond
-
+

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

+ + +
Updating -

+ +

If you downloaded and compiled the game and the game data fomr the subversion repository, there is no need to re-download the entire distribution when there are updates available. You can update your local copy and rebuild it.

Update the source code: -

-cd osirion
-make clean
+

+cd osirion

+make clean

 svn update
-
+

Update the game data: -

-cd data
-svn update
+

+

+cd data

+svn update

 cd ..
-
+

Rebuild the binaries: -

-autoreconf
-./configure
+

+autoreconf

+./configure

 make
-
-

+ + + +
GtkRadiant 1.5.0 support files (optional) -

+ +

You can skip this section if you do not intent to create to create models with gtkradiant 1.5. Note that these files probably won't work with other versions. You can find precompiled @@ -237,43 +291,55 @@ make directory on your system, edit these instructions accordingly.

Copy the support files to the gtkradiant folder: -

-cd data
-cd gtkradiant
+

+

+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/yourname/osirion, then the data will be in /home/yourname/osirion/data and the line should look like this: -

+

+

 enginepath_linux="/home/yourname/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 from the subversion repository: -

+

+

 svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
-
-

+

+ + +
Organization of the distribution - +
+
 /doc 	Documentation
 
@@ -295,6 +361,7 @@ Organization of the distribution
 	/math			mathematical classes and functions
 	/sys			low-level system functions
 	/render			render library
+	/ui			user interface widget library
 
 /data	Data files
 
@@ -304,11 +371,10 @@ Organization of the distribution
 		/maps		game world models
 		/scripts	gtkradiant shader files
 		/textures	game world textures
+
 	/gtkradiant		gtkradiant support files
+
-

- back -

diff --git a/doc/keys/f1.png b/doc/keys/f1.png new file mode 100644 index 0000000..5172443 Binary files /dev/null and b/doc/keys/f1.png differ diff --git a/doc/keys/f6.png b/doc/keys/f6.png new file mode 100644 index 0000000..d215fa5 Binary files /dev/null and b/doc/keys/f6.png differ diff --git a/doc/keys/tilde.png b/doc/keys/tilde.png new file mode 100644 index 0000000..ab8b669 Binary files /dev/null and b/doc/keys/tilde.png differ diff --git a/doc/keys/v.png b/doc/keys/v.png new file mode 100644 index 0000000..9ce0882 Binary files /dev/null and b/doc/keys/v.png differ diff --git a/doc/main.css b/doc/main.css new file mode 100644 index 0000000..beffd7f --- /dev/null +++ b/doc/main.css @@ -0,0 +1,222 @@ +a { + color: #dd0000; + text-decoration: none; +} + +a:hover { + color: #ff0000; + text-decoration: none; +} + +body { + background: #ffffff; + color: #000000; +} + +img { + border: 0px; +} + +.rfloater, .lfloater { + margin-top: 16px; + margin-bottom: 16px; + +} +.rfloater { + margin-left: auto; + margin-right: 48px; + padding-left: 16px; + float: right; +} + +.lfloater { + margin-left: 48px; + margin-right: 16px; + padding-right: 16px; +} + +.icon { + margin: auto 24px; + text-align: right; + float: right; +} + +.w3cicon { + text-align: right; + vertical-align: middle; + margin-left: auto; + margin-right: 24px; + margin-top: 8px; + margin-bottom: auto; + float: right; +} + +.banner, .header, .footer, .title { + background: #d7d7d7; + margin-left: 24px; + margin-right: 24px; + padding: 4px; + border-top: 1px solid #606060; + border-bottom: 1px solid #606060; +} + +.banner, .header, .footer { + margin-top: 24px; + margin-bottom: 24px; +} + +.header { + font-size: 12pt; + padding: 8px; +} + +.banner { + font-size: 18pt; + padding: 8px; + text-align: center; +} + +.footer { + margin-top: 24px; + font-family: "Courier New", "Courier", "fixed"; + font-size: 8pt; + padding: 0px; + padding-left: 8px; + clear: both; +} + +.title { + font-size: 16pt; +} + +.subtitle { + background: #e7e7e7; + margin-left: 48px; + margin-right: 24px; + margin-top: 8px; + margin-bottom: 8px; + font-size: 12pt; + border-top: 1px solid #606060; + border-bottom: 1px solid #606060; + border-left: 1px solid #606060; + padding: 4px; + padding-left: 8px; +} + +.text, .nav, .toolbox { + margin-left: 48px; + margin-right: 72px; +} + +.text, .toolbox { + font-size: 12pt; + border-top: 1px solid #606060; + border-bottom: 1px solid #606060; + border-left: 1px solid #606060; + border-right: 1px solid #606060; + padding: 8px; + margin-top: 8px; + margin-bottom: 8px; +} + +.nav { + font-family: "Courier New", "Courier", "fixed"; + font-size: 10pt; + margin-top: 24px; + margin-bottom: 24px; + padding: 8px; + padding-bottom: 0px; + padding-top: 0px; + clear: both; +} + +.toolbox { + margin-left: 24px; +} + +.newsbox, .datebox { + margin-left: 48px; + margin-right: 24px; + padding-left: 8px; + padding-right: 8px; + font-size: 12pt; +} + +.newsbox { + border-bottom: 1px solid #606060; + border-left: 1px solid #606060; + border-right: 1px solid #606060; + padding: 8px; + margin-bottom: 8px; +} + +.datebox { + background-color: #f0f0f0; + border-top: 1px solid #606060; + border-left: 1px solid #606060; + border-right: 1px solid #606060; + margin-top: 8px; +} + +.yellow { + color: yellow; +} + +.red { + color: red; +} + +.files + { + font-size: 12pt; + text-align: left; + padding: 4px; +} + +.md5 { + font-family: "Courier New", "Courier", "fixed"; + font-size: 10pt; +} + +.filesize { + text-align: right; +} + +.code { + background: #f0f0f0; + border-top: 1px solid #606060; + border-bottom: 1px solid #606060; + border-left: 1px solid #606060; + border-right: 1px solid #606060; + margin-left: 48px; + margin-right: 48px; + margin-top: 8px; + margin-bottom: 8px; + padding-left: 16px; + font-family: "Courier New", "Courier", "fixed"; + font-size: 12pt; +} + +.doc { + font-size: 12pt; + border: 0; +} + +.screenshot { + font-size: 10pt; + text-align: center; + padding: 16px; + vertical-align: top; + clear: both; +} + +.mainleft { + margin-left: -1px; + width: 50%; + float: left; +} + +.mainright { + margin-left: 50%; + margin-right: 0px; +} -- cgit v1.2.3