major documentation update

author: Stijn Buys <ingar@osirion.org> 2009-02-23 18:31:03 +0000
committer: Stijn Buys <ingar@osirion.org> 2009-02-23 18:31:03 +0000
commit: 634b12e329b0e1e305490c6bc87ce414fd027add (patch)
tree: d978be6f96719e92cf89c743854a621a3c169263 /doc
parent: 1a4ae6ca5cd3aac0fd639c554e824525d98676ea (diff)
12 files changed, 603 insertions, 239 deletions
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 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.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 - Attributions</TITLE>
+	<link rel="stylesheet" type="text/css" href="main.css">
+	<TITLE>Project::OSiRiON - Attributions</TITLE>
 </head>
 
 <body>
-<H1>
-	The Osirion Project - Attributions
-</H1>
+<div class="banner">
+	<img src="images/banner.png" ALT="Project::OSiRiON">
+	<br>
+	Attributions
+</div>
+
+<div class="text">
 <p>
-	The Project::OSiRiON game data is distributed under the terms and conditions
+	The game data is distributed under the terms and conditions
 	of the <a href="http://creativecommons.org/licenses/by-sa/3.0/">Create Commons Attribution-Share Alike 3.0 License</a>.
+</p>
 <p>
 	Files by <a href="http://freesound.iua.upf.edu/usersViewSingle.php?id=731">nathanshadow</a>
 	are distributed under the terms of the 
 	<a href="http://creativecommons.org/licenses/sampling+/1.0/">Creative Commons Sampling Plus 1.0</a> license.
+</p>
 <p>
 	Files by <a href="http://www.nasa.gov">NASA</a> are in the
 	<a href="http://www.nasa.gov/audience/formedia/features/MP_Photo_Guidelines.html">public domain</a>.
-	
-<h2>
+</p>
+</div>
+
+<div id="contributions" class="title">
 	Contributions
-</h2>
+</div>
+<div class="text">
 <p>
 	These files were contributed to the project:
+</p>
 <p>
+<div class="code">
 <table>
 	<tr>
 		<TD><i>directory</i></td>
@@ -191,13 +202,21 @@
 		</td>
 	</tr>
 </table>
+</div>
+
+</p>
 
-<h2>
+</div>
+
+<div id="derived_works" class="title">
 	Derived works
-</h2>
+</div>
+<div class="text">
 <p>
 	These files are available on the internet or are based on freely available works:
+</p>
 <p>
+<div class="code">
 <table>
 	<tr>
 		<TD><i>directory</i></td>
@@ -267,7 +286,11 @@
 		</td>
 	<tr>
 </table>
-	
+</div>
+
+</p>
+</div>
+
 </body>
 <html>
 
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 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.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 - Player guide</TITLE>
+	<link rel="stylesheet" type="text/css" href="main.css">
+	<TITLE>Project::OSiRiON - Player Guide</TITLE>
 </head>
 
 <body>
-
-<h1>
-	The Osirion Project - Player guide
-</h1>
+<div class="banner">
+	<img src="images/banner.png" ALT="Project::OSiRiON">
+	<br>
+	Player Guide
+</div>
+<div class="text">
 <p>
 	<i>OK Space Cadets, prepare to hurtle through the Cosmos!</i>
 </p>
 	
 <p>
 	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.
 </p>
 <p>
 	Before you can be allowed to pilot a space ship, make sure you have reviewed
 	the <a href="installation.html">installation instructions</a> to ensure
-	a smooth operation of the onboard computer systems. Advanced topics
-	are covered by the <a href="manual.html">user manual</a>.
+	optimal performance of the onboard computer systems. Advanced topics
+	and server operations are covered by the <a href="manual.html">user manual</a>.
 </p>
+</div>
 
-<h2>
-	User Interface
-</h2>
-
-<h2>
-	HUD
-</h2>
+<div class="title">
+	Getting Started
+</div>
 
-<h2>
-	Fligh controls
-</h2>
-
-<h2>
-	Keyboard
-</h2>
+<div class="text">
+	<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 local game, the <i>Internet</i>
+	button will take you to the test server. 
+</p>
+<p>
+	The <i>Options</i> button will open the options menu where you can
+	customize your settings.
+</p>
 <p>
-	This is the default keyboard configuration:
+	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>
+	button to leave the game and return to the main menu.
 </p>
+<p>
+	<img src="keys/f1.png" ALT=""> Later on, you can press the <b>F1</b> key to return to the game menu.
+</p>
+<p>
+	<img src="keys/tilde.png" ALT=""> You can press the <b>~</b> key at any time to open the command console.
+</p><p>
+	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.
+</p>
+</div>
 
-<h2>
-	Joystick
-</h2>
+<div id="controls" class="title">
+	Controls
+</div>
+
+<div class="subtitle">
+	Camera
+</div>
+
+<div class="text">
 <p>
-	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:
+	<i>tracking view</i>, the default mode, <i>cockpit view</i> and <i>free view</i>.
+</p><p>
+	<img src="keys/v.png" ALT=""> Press the <b>V</b> key to switch to the next view.
+</p><p>
+	<img src="keys/shift.png" ALT=""> <img src="keys/v.png" alt=""> Press <B>shift + V</b> to switch to the previous view.
+</p><p>
+	<img src="keys/div.png" ALT=""> Press <b>keypad /</b> to zoom in.
+</p><p>
+	<img src="keys/mul.png" ALT=""> Press <b>keypad *</b> to zoom out.
+</p><p>
+	Zoom is disabled in cockpit view.
+</p><p>
+	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.
+</p><p>
+	<img src="keys/spacebar.png" alt=""> Press <b>spacebar</b> 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.
 </p>
+</div>
+
+<div class="subtitle">
+	Flight Controls
+</div>
 
-<h2 class="navigate">
-	<a href="index.html">back</a>
-</h2>
+<div class="subtitle">
+	Navigation Controls
+</div>
 
 </body>
-</html>
-\ No newline at end of file
+</html>
diff --git a/doc/images/banner.jpg b/doc/images/banner.jpg
new file mode 100644
index 0000000..067e5e7
--- /dev/null
+++ b/doc/images/banner.jpg
diff --git a/doc/images/banner.png b/doc/images/banner.png
new file mode 100644
index 0000000..c702afa
--- /dev/null
+++ b/doc/images/banner.png
diff --git a/doc/images/main_menu.jpg b/doc/images/main_menu.jpg
new file mode 100644
index 0000000..43cbd82
--- /dev/null
+++ b/doc/images/main_menu.jpg
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 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.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</TITLE>
+	<link rel="stylesheet" type="text/css" href="main.css">
+	<TITLE>Project::OSiRiON - Documentation</TITLE>
 </head>
 
 <body>
-<H1>
-	The Osirion Project
-</H1>
 
+<!-- DOCUMENTATION ========================================================== -->
+
+<div class="banner">
+	<img src="images/banner.png" ALT="Project::OSiRiON">
+	<br>
+	Documentation
+</div>
+
+<div class="text">
 <p>
-	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. 
-</p><p>
-	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.
-</p><p>
-	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.
 </p>
-<H2>
-	Project::OSiRiON
-</H2>
 
 <p>
-	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 <a href="http://www.microsoft.com/games/freelancer/">Freelancer</a> and 
-	<A href="http://wcuniverse.sourceforge.net/announcements.htm">Privateer</a>.
-</p><p>
-	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.
+</p>
+<p>
+  All game world data is loaded from easy to edit text files and each server can
+  offer its own customized game world.
 </p>
+<p>
+  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.
+</p>
+<p>
+  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.
+</p>
+</div>
 
-<h2>
+<div id="content" class="title">
 	Content
-</h2>
+</div>
+<div class="text">
 <p>
 	<ul>
-		<li><a href="installation.html">Installation</a>
+		<li><a href="installation.html">Installation Instructions</a>
 	</ul>
 	<ul>
-		<li><a href="guide.html">Player guide</a> (under construction)
-		<li><a href="manual.html">User manual</a>
+		<li><a href="guide.html">Player Guide</a>
+		<li><a href="manual.html">User Manual</a>
 	</ul>
 	<ul>
 		<li><a href="world.html">Editing the world</a>
 		<li><a href="models.html">Creating models</a>
 	</ul>
+	<ul>
+		 <li><a href="attributions.html">Attributions</a>
+	</ul>
 </p>
+</div>
 
-<h2>
-	Project contributors
-</h2>
+<div id="contributors" class="title">
+	Project Contributors
+</div>
 
+<div class="text">
 	<table><TR>
 		<td>Ingar=KCT=</td>
-		<td>Game design, programming, modelling, graphics, sounds
+		<td>Project head, programming, modelling, graphics, sounds, world
 		</td></tr>
 
+		<td>Odin</td>
+		<td>Modelling, graphics, world</td>
+		</tr>
+
 		<td>[mDc]Thorn</td>
-		<td>Design advice, modelling, graphics
+		<td>Design advice, graphics, modelling
 		</td></tr>
 
 		<td>Supertanker</td>
 		<td>Modelling
 		</td></tr>
 
-		<td>Odin</td>
-		<td>Modelling</td>
-		</tr>
-
 		<td>Josky=KCT=</td>
 		<td>Design advice
 		</td></tr>
@@ -90,44 +98,48 @@
 		Alpha testing
 		</td></tr>
 	</table>
+</div>
 
-<h2>
-	Website
-</h2>
+<div id="internet" class="title">
+	Internet
+</div>
+<div class="text">
 <p>
-	The website for the osirion project can be found at
+	The website for Project::OSiRiON can be found at
 	<a href="http://ingar.satgnu.net/osirion">http://ingar.satgnu.net/osirion</a>
 </p>
-
-<h2>
-	IRC
-</h2>
 <p>
-	The official Osirion IRC channel is #osirion on irc.soliter.org
+	The official Osirion IRC channel is <i>#osirion</i> on <i>irc.soliter.org</i>.
 </p>
+</div>
 
-<h2>
+<div id="copyright" class="title">
 	Copyright
-</h2>
+</div>
+<div class="text">
 <p>
-	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
 	<a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License</a>.
-</p><p>
-	The Project::OSiRiON game data is distributed under the terms and conditions
-	of the <a href="http://creativecommons.org/licenses/by-sa/3.0/">Create Commons Attribution-Share Alike 3.0 License</a>.<br>
-	However, a few files are distributed under the terms of a different license.
+</p>
+<p>
+	The game data is distributed under the terms and conditions of the
+	<a href="http://creativecommons.org/licenses/by-sa/3.0/">Create Commons Attribution-Share Alike 3.0 License</a>.<br>
+</p>
+<p>
+	A few files are distributed under the terms of a different license.
 	Please read the <A href="attributions.html">list of attributions</a> for a complete overview
 	of authors and copyright.
+</p>
 <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.
+</p>
+</div>
 
-<h2>
+<div id="acknowledgements" class="title">
 	Acknowledgements
-</h2>
+</div>
+<div class="text">
 <p>
 	This project could not have been possible without the work of others:
 	<ul>
@@ -142,16 +154,12 @@
 		<li>A special thanks to all =KCT= members
 	</ul>
 </p>
-
-<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>
 <p>
-	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.
 </p>
 
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 @@
- 
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.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 - Installation</TITLE>
+	<link rel="stylesheet" type="text/css" href="main.css">
+	<TITLE>Project::OSiRiON - Installation Instructions</TITLE>
 </head>
+
 <body>
+<div class="banner">
+	<img src="images/banner.png" ALT="Project::OSiRiON">
+	<br>
+	Installation Instructions
+</div>
 
-<h1>
-	The Osirion Project - Installation
-</h1>
+<div class="text">
 <p>
-	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.
 <ul>
-	<li><a href="#precompiled">Using precompiled executables</a>
+	<li><a href="#packages">Using packages</a>
 	<li><a href="#building_from_source">Building from source code</a>
 	<li><a href="#gtkradiant">GtkRadiant 1.5.0 support files (optional)</a>
 	<li><a href="#source_data">Source data (optional)</a>
 </ul>
-<h2 id="precompiled">
-	Using precompiled executables
-</h2>
-<p>
-	You can find the latest version in the download section of the website:<br>
-	<a href="http://ingar.satgnu.net/osirion/files">http://ingar.satgnu.net/osirion/files</a>
-<h3>
+</div>
+
+<div id="packages" class="title">
+	Using packages
+</div>
+<div class="text">
+<p>
+	You can find the latest version in the downloads section of the website:<br>
+	<a href="http://ingar.satgnu.net/osirion/index.html#downloads">http://ingar.satgnu.net/osirion</a>
+</p>
+</div>
+
+<div class="subtitle">
 	Windows
-</h3>
+</div>
+
+<div class="text">
 <p>
-	Download the windows executables package:<br>
+	Download the windows package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-win32-latest.zip">osirion-win32-latest.zip</a><br>
-	This packages contains the win32 version of the server and the client.
+	This package contains the win32 version of the server and the client.
 <p>
 	Dowload the game data package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-data-latest.zip">osirion-data-latest.zip</a><br>
@@ -45,52 +55,68 @@
 	game data.
 <p>
 	Open the game directory in explorer and click on <i>osirion.exe</i> to start the client.
-<h3>
+</div>
+
+<div class="subtitle">
 	Linux
-</h3>
+</div>
+
+<div class="text">
+
 <p>
-	Download the linux executables packages:<br>
+	Download the linux packages:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-linux-latest.zip">osirion-linux-latest.zip</a><br>
-	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.
 <p>
 	Extract the package, a new subdirectory will be created. The actual directory name will depend on
 	the version number. Enter the new subdirectory.
-<pre>
-tar jxvf osirion-latest.tar.bz2
+<div class="code">
+tar jxvf osirion-latest.tar.bz2<br>
 cd osirion-0.1_258-linux
-</pre>
+</div>
 <p>
 	Dowload the game data package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-data-latest.zip">osirion-data-latest.zip</a><br>
 <p>
 	Unzip it:
-<pre>
+<div class="code">
 unzip ../osirion-data-latest.zip
-</pre>
+</div>
 <p>
-	 To run the 32bit client:
-<pre>
+	 To run the 32 bit client:
+<div class="code">
 ./osirion.x86
-</pre>
+</div>
 <p>
-	 To run the 64bit client:
-<pre>
+	 To run the 64 bit client:
+<div class="code">
 ./osirion.x86_64
-</pre>
-<h2 id="building_from_source">
+</div>
+
+</div>
+
+<div id="building_from_source" class="title">
 	Building from source code
-</h2>
-<h3>
-	Requirements
-</h3>
+</div>
+
+<div class="text">
 <p>
 	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.
+</p>
+</div>
+<div class="subtitle">
+      Requirements
+</div>
+
+<div class="text">
 <p>
+
 	To build the client or the dedicated server:
 	<ul>
 		<li>zlib
 	</ul>
+</p>
 <p>
 	To build the client:
 	<ul>
@@ -101,131 +127,159 @@ unzip ../osirion-data-latest.zip
 		<li><A href="http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx">OpenAL</a>
 				or <a href="http://kcat.strangesoft.net/openal.html">OpenAL Soft</a>
 	</ul>
+</p>
 <p>
 	You will also need a recent version of gcc, GNU make, automake and libtool.
-<p>
 	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:
-	<ul>
-		<li>linux-x86_64, gcc 4.3.1 (Arch Linux)
-		<li>linux-x86_64, gcc 4.1.2
-		<li>linux-i686, gcc 4.3.1 (Arch Linux)
-		<li>linux-i686, gcc 4.1.2
-		<li>mingw32, gcc 4.2.2
-	</ul>
-<h3>
-	Obtaining the source code
-</h3>
+	supported by SDL.
+</p>
+</div>
+
+<div class="subtitle">
+      Obtaining the source code
+</div>
+<div class="text">
 <p>
 	You can get the osirion project source code from the subversion repository:<br>
 	<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a>
+</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.
-<pre>
+</p>
+<div class="code">
 svn co svn://intranifty.no-ip.org/osirion osirion
-</pre>
+</div>
 <p>
 	On windows, you can use the Turtoisesvn SubVersion client to access the
 	SVN repositories. You can download it here:<br>
-	<a href="http://tortoisesvn.tigris.org/">http://tortoisesvn.tigris.org/</a>
+	<a href="http://tortoisesvn.tigris.org">http://tortoisesvn.tigris.org</a>
+</p>
 <p>
-	You can also get the source package from the website:<br>
+	You can also download the source package from the website:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-src-latest.tar.bz2">osirion-src-latest.tar.bz2</a>
-<h3>
-	Compiling the source code
-</h3>
+</p>
+</div>
+
+<div class="subtitle">
+      Compiling the source code
+</div>
+<div class="text">
 <p>
 	Enter the new directory and configure the source code:
-<pre>
-cd osirion
-autoreconf -fi
-./configure
-</pre>
+<div class="code">
+cd osirion<br>
+autoreconf -fi<br>
+./configure<br>
+</div>
+
 <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>:
-<pre>
+</p>
+<div class="code">
 ./configure --without-client
-</pre>
+</div>
 <p>
-	If <i>configure</i> finds the ncurses library, the server will be build
-	with an ncurses console. To disable ncurses detection, pass the
-	<i>--without-ncurses</i> option to <i>configure</i>.
+	If <i>configure</i> 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>.
+</p>
 <p>
 	<b>Important</b>: <i>make install</i> is not supported. Results are unpredictable.
+</p>
 <p>
 	Compile the source code:
-<pre>
+</p>
+<div class="code">
 make
-</pre>
+</div>
 <p>
 	The binaries will be build in the <i>src</i> subdirectory of the main distribution.
-<h3>
-	Obtaining the game data 
-</h3>
+</p>
+</div>
+
+<div class="subtitle">
+      Obtaining the game data 
+</div>
+<div class="text">
 <p>
 	The game data should be located in the <i>data</i> subdirectory of the main distribution.
 	You can use the game data package from the website or get it from the osirion-data subversion repository:<br>
 	<a href="svn://intranifty.no-ip.org/osirion-data">svn://intranifty.no-ip.org/osirion-data</a>
+</p>
 <p>
 	Run the following command from within the main distribution directory to download
 	the game data into the <i>data</i> subdirectory:
-<pre>
+</p>
+<div class="code">
 svn checkout svn://intranifty.no-ip.org/osirion-data data
-</pre>
-</body>
-<h3>
-	Executing
-</h3>
+</div>
+
+</div>
+
+<div class="subtitle">
+      Executing
+</div>
+<div class="text">
 <p>
-	The client and the dedicated server look for the game data in the <i>data</i> subdirectory 
+	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 to copy them with the <i>src/</i> prefix.
+</p>
 <p>
-	To start the client
-<pre>
+	To start the client:
+</p>
+<div class="code">
 src/osirion
-</pre>
+</div>
 <p>
-	To start the dedicated server
-<pre>
+	To start the dedicated server:
+</p>
+<div class="code">
 src/osiriond
-</pre>
+</div>
 <p>
-	Of you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
-<h3>
+	If you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
+</p>
+</div>
+
+<div class="subtitle">
 	Updating
-</h3>
+</div>
+<div class="text">
 <p>
 	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.
 <p>
 	Update the source code:
-<pre>
-cd osirion
-make clean
+<div class="code">
+cd osirion<br>
+make clean<br>
 svn update
-</pre>
+</div>
 <p>
 	Update the game data:
-<pre>
-cd data
-svn update
+</p>
+<div class="code">
+cd data<br>
+svn update<br>
 cd ..
-</pre>
+</div>
 <p>
 	Rebuild the binaries:
-<pre>
-autoreconf
-./configure
+<div class="code">
+autoreconf<br>
+./configure<br>
 make
-</pre>
-<h2 id="gtkradiant">
+</div>
+</div>
+
+<div id="gtkradiant" class="title">
 	GtkRadiant 1.5.0 support files (optional)
-</h2>
+</div>
+<div class="text">
 <p>
 	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.
 <p>
 	Copy the support files to the gtkradiant folder:
-<pre>
-cd data
-cd gtkradiant
+</p>
+<div class="code">
+cd data<br>
+cd gtkradiant<br>
 cp -vr * /usr/local/games/gtkradiant-1.5.0
-</pre>
+</div>
 <p>
 	Open the file <i>/usr/local/games/gtkradiant-1.5.0/games/osirion.game</i> in 
 	your favourite editor. Look for a line that begins with:
-<pre>
+</p>
+<div class="code">
 enginepath_linux="
-</pre>
+</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 
 	the line should look like this:
-<pre>
+</p>
+<div class="code">
 enginepath_linux="/home/yourname/osirion/data"
-</pre>
+</div>
 <p>
 	Save the changes.
-<h2 id="source_data">
+</p>
+</div>
+
+<div id="source_data" class="title">
 	Source data (optional)
-</h2>
+</div>
+<div class="text">
 <p>
 	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.
+</p>
 <p>
 	To download the source data from the subversion repository:
-<pre>
+</p>
+<div class="code">
 svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
-</pre>
-<h2 id="organization">
+</div>
+</div>
+
+<div class="title">
 Organization of the distribution
-</h2>
+</div>
+<div class="text">
 <pre>
 /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
 </pre>
+</div>
 
-<h2 class="navigate">
-		<a href="index.html">back</a>
-</h2>
 </body>
 </html>
diff --git a/doc/keys/f1.png b/doc/keys/f1.png
new file mode 100644
index 0000000..5172443
--- /dev/null
+++ b/doc/keys/f1.png
diff --git a/doc/keys/f6.png b/doc/keys/f6.png
new file mode 100644
index 0000000..d215fa5
--- /dev/null
+++ b/doc/keys/f6.png
diff --git a/doc/keys/tilde.png b/doc/keys/tilde.png
new file mode 100644
index 0000000..ab8b669
--- /dev/null
+++ b/doc/keys/tilde.png
diff --git a/doc/keys/v.png b/doc/keys/v.png
new file mode 100644
index 0000000..9ce0882
--- /dev/null
+++ b/doc/keys/v.png
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;
+}
author	Stijn Buys <ingar@osirion.org>	2009-02-23 18:31:03 +0000
committer	Stijn Buys <ingar@osirion.org>	2009-02-23 18:31:03 +0000
commit	634b12e329b0e1e305490c6bc87ce414fd027add (patch)
tree	d978be6f96719e92cf89c743854a621a3c169263 /doc
parent	1a4ae6ca5cd3aac0fd639c554e824525d98676ea (diff)