Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2012-05-01 19:07:53 +0000
committerStijn Buys <ingar@osirion.org>2012-05-01 19:07:53 +0000
commit836799946d9da0d68ba93a6857b2c0ba3617c89d (patch)
tree690656e0d4f41177258fbb7b521e111d877e7bca /doc
parent3e73e7bbb42a0226dba951372c90c59ac7d036aa (diff)
Updated documentation, match documentation style with website stylesheet.
Diffstat (limited to 'doc')
-rw-r--r--doc/attributions.html723
-rw-r--r--doc/images/background.jpgbin0 -> 51597 bytes
-rw-r--r--doc/images/banner.pngbin3511 -> 3372 bytes
-rw-r--r--doc/images/bullet.pngbin0 -> 120 bytes
-rw-r--r--doc/index.html256
-rw-r--r--doc/installation.html3
-rw-r--r--doc/installation_develop.html347
-rw-r--r--doc/installation_release.html138
-rw-r--r--doc/installation_source.html276
-rwxr-xr-xdoc/osirion.css282
-rw-r--r--doc/starsystem_roadmap.html69
11 files changed, 1679 insertions, 415 deletions
diff --git a/doc/attributions.html b/doc/attributions.html
index 02474ab..8888c74 100644
--- a/doc/attributions.html
+++ b/doc/attributions.html
@@ -2,18 +2,39 @@
<html lang="en">
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
- <link rel="stylesheet" type="text/css" href="main.css">
- <TITLE>Project::OSiRiON - Attributions</TITLE>
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Attributions</title>
</head>
<body>
-<div class="banner">
- <img src="images/banner.png" ALT="Project::OSiRiON">
- <br>
- Attributions
-</div>
+<div id="page">
+
+<!-- header and menu ======================================= -->
+
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
-<div class="text">
+<div id="content">
+
+<!-- Attributions ================================================== -->
+
+<h1>Attributions</h1>
<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>.
@@ -22,342 +43,350 @@
Sound effects from the Freesound project are distributed under the terms and conditions of the
<a href="http://creativecommons.org/licenses/sampling+/1.0/">Creative Commons Sampling Plus 1.0</a> license.
</p>
-</div>
-<div class="title">
- List of data files
-</div>
+<!-- List of data files ============================================ -->
-<div class="text">
+<h2>List of data files</h2>
<p>
A list of game data files in the data/base directory,
with their original author and/or source.
</p>
-<table class="code">
-
-<!-- MAPS ========================================================== -->
-
- <tr class="divider">
- <TD><i>Directory</i></td>
+<table class="fixed">
+ <tr>
+ <td><i>Directory</i></td>
<td><i>File(s)</i></td>
<td><i>Original author</i></td>
</tr>
-<tr class="divider">
- <td>maps/cargo</td>
- <td>crate.map</td>
- <td>Ingar</td>
-</tr>
-<tr class="divider">
- <td>maps/cargo</td>
- <td>pod.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>alexandria.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>alexandria_storage.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>cantor.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>custodian.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>helianthos.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>ikarus.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>jumpgate.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>regula.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>regula_storage.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/colonial</td>
- <td>sharkan.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/derelict</td>
- <td>ares.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/derelict</td>
- <td>hades.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>avenger.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>betelgeuse.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>bumblebee.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>ensor.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>galaxy.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>horizon.map</td>
- <td>Thorn</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>jupiter.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>orion.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>researchstation.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>shootingstar.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/independent</td>
- <td>trident.map</td>
- <td>Your_Face</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>avatar.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>halcyon.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>lindblade_central.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>lindblade_dock.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>powersat.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>station15.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/lindblade</td>
- <td>supertanker.map</td>
- <td>Supertanker</td>
-</tr>
-<tr>
- <td>maps/mercenary</td>
- <td>archer.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/mercenary</td>
- <td>enforcer.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/mercenary</td>
- <td>longbow.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/mercenary</td>
- <td>pod.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/mercenary</td>
- <td>talon.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/merchant</td>
- <td>matrix.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/merchant</td>
- <td>scalar.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/merchant</td>
- <td>vector.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/miners</td>
- <td>cruiser.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/pirate</td>
- <td>juggernaut.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/pirate</td>
- <td>jumpgate.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/pirate</td>
- <td>raider.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/race</td>
- <td>checkpoint.map</td>
- <td>Ingar</td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>cannon001.map</td>
- <td></td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>cannon002.map</td>
- <td></td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>cargopod001.map</td>
- <td></td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>navpoint.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>turret001.map</td>
- <td></td>
-</tr>
-<tr>
- <td>maps/static</td>
- <td>turret002.map</td>
- <td></td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>camel.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>civilian_housing.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>civilian_starscraper.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>colosus.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>imp.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>inquisitor.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>obliterator.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>panzer.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>ravager.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>tsukhan_central.map</td>
- <td>Mega</td>
-</tr>
-<tr>
- <td>maps/tsukhan</td>
- <td>warbringer.map</td>
- <td>Mega</td>
-</tr>
+<!-- MAPS ========================================================== -->
+
+ <tr>
+ <td colspan=3>
+ <h3>Maps</h3>
+ <hr>
+ </td>
+ </tr>
+ <tr>
+ <td>maps/cargo</td>
+ <td>crate.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/cargo</td>
+ <td>pod.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>alexandria.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>alexandria_storage.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>cantor.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>custodian.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>helianthos.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>ikarus.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>jumpgate.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>regula.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>regula_storage.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/colonial</td>
+ <td>sharkan.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/derelict</td>
+ <td>ares.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/derelict</td>
+ <td>hades.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>avenger.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>betelgeuse.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>bumblebee.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>ensor.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>galaxy.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>horizon.map</td>
+ <td>Thorn</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>jupiter.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>orion.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>researchstation.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>shootingstar.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/independent</td>
+ <td>trident.map</td>
+ <td>Your_Face</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>avatar.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>halcyon.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>lindblade_central.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>lindblade_dock.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>powersat.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>station15.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/lindblade</td>
+ <td>supertanker.map</td>
+ <td>Supertanker</td>
+ </tr>
+ <tr>
+ <td>maps/mercenary</td>
+ <td>archer.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/mercenary</td>
+ <td>enforcer.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/mercenary</td>
+ <td>longbow.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/mercenary</td>
+ <td>pod.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/mercenary</td>
+ <td>talon.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/merchant</td>
+ <td>matrix.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/merchant</td>
+ <td>scalar.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/merchant</td>
+ <td>vector.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/miners</td>
+ <td>cruiser.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/pirate</td>
+ <td>juggernaut.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/pirate</td>
+ <td>jumpgate.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/pirate</td>
+ <td>raider.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/race</td>
+ <td>checkpoint.map</td>
+ <td>Ingar</td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>cannon001.map</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>cannon002.map</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>cargopod001.map</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>navpoint.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>turret001.map</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>maps/static</td>
+ <td>turret002.map</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>camel.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>civilian_housing.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>civilian_starscraper.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>colosus.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>imp.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>inquisitor.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>obliterator.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>panzer.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>ravager.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>tsukhan_central.map</td>
+ <td>Mega</td>
+ </tr>
+ <tr>
+ <td>maps/tsukhan</td>
+ <td>warbringer.map</td>
+ <td>Mega</td>
+ </tr>
<!-- MODELS ======================================================== -->
<tr>
+ <td colspan=3>
+ <h3>Models</h3>
+ <hr>
+ </td>
+ </tr>
+ <tr>
<td>models/asteroid</td>
<td>asteroid1</td>
<td>Karvajalka</td>
@@ -381,6 +410,12 @@
<!-- SOUNDS ======================================================== -->
<tr>
+ <td colspan=3>
+ <h3>Sounds</h3>
+ <hr>
+ </td>
+ </tr>
+ <tr>
<td>sounds/engines</td>
<td>loop00.wav</td>
<td>
@@ -421,7 +456,13 @@
<!-- TEXTURES ====================================================== -->
- <tr class="divider">
+ <tr>
+ <td colspan=3>
+ <h3>Textures</h3>
+ <hr>
+ </td>
+ </tr>
+ <tr>
<td>textures/kuroto</td>
<td>all files</td>
<td>
@@ -429,7 +470,7 @@
(released under CC-BY-SA-3.0 with permission)
</td>
</tr>
- <tr class="divider">
+ <tr>
<td>textures/planets</td>
<td>albion.jpg</td>
<td>
@@ -438,7 +479,7 @@
<a href="http://www.celestiamotherlode.net/catalog/show_creator_details.php?creator_id=153">Chance Ragen</a><br>
(released under CC-BY-SA-3.0 with permission)
</tr>
- <tr class="divider">
+ <tr>
<td>textures/planets</td>
<td>antwerp.png</td>
<td>
@@ -529,8 +570,26 @@
</tr>
</table>
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+</div>
</body>
</html>
+
diff --git a/doc/images/background.jpg b/doc/images/background.jpg
new file mode 100644
index 0000000..5536114
--- /dev/null
+++ b/doc/images/background.jpg
Binary files differ
diff --git a/doc/images/banner.png b/doc/images/banner.png
index c702afa..7c3e8b1 100644
--- a/doc/images/banner.png
+++ b/doc/images/banner.png
Binary files differ
diff --git a/doc/images/bullet.png b/doc/images/bullet.png
new file mode 100644
index 0000000..2f6655e
--- /dev/null
+++ b/doc/images/bullet.png
Binary files differ
diff --git a/doc/index.html b/doc/index.html
index 50db56f..b571dd5 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,27 +2,47 @@
<html lang="en">
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
- <link rel="stylesheet" type="text/css" href="main.css">
- <TITLE>Project::OSiRiON - Documentation</TITLE>
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Documentation</title>
</head>
<body>
+<div id="page">
-<!-- DOCUMENTATION ========================================================== -->
+<!-- header and menu ======================================= -->
-<div class="banner">
- <img src="images/banner.png" ALT="Project::OSiRiON">
- <br>
- Documentation
-</div>
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
+
+<div id="content">
+
+<!-- Documentation ========================================= -->
-<div class="text">
+<div id="about">
+<h1>About</h1>
<p>
Project::OSiRiON is a free space trading and combat simulation under development.
Its goal is to create an immersive universe with open gameplay inspired by classic titles such as
<a href="http://en.wikipedia.org/wiki/Wing_Commander:_Privateer">Privateer</a> and
<a href="http://en.wikipedia.org/wiki/Freelancer_(video_game)">Freelancer</a>.
</p>
+<!-- <img src="images/logo.png" ALT="Project::OSiRiON logo">-->
<p>
The engine is written from scratch in C++ and uses SDL, OpenGL, OpenAL, libjpeg, libpng, zlib
and the <a href="http://www.bulletphysics.com/">Bullet physics library</a>. It is
@@ -30,9 +50,9 @@
</p>
<p>
The basic components are already in place: players can start a single-player game,
- or join a network server. They can purchase a ship and explore the universe and can even earn
- some cash trading cargo. Other important parts are still missing: games can not be saved and
- there are no weapon nor combat features.
+ or join a network server. They can purchase a ship, explore the universe and earn
+ some cash trading cargo. Other important parts, like weapons and combat features,
+ are still missing.
</p>
<p>
The game aims to be fully customizable. Common and easy to edit file formats
@@ -43,40 +63,66 @@
</p>
</div>
-<div id="content" class="title">
- Content
-</div>
-<div class="text">
-<p>
- <ul>
- <li><a href="installation.html">Installation Instructions</a>
- </ul>
- <ul>
- <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>
+<!-- Documentation content ========================================= -->
+
+<hr>
+<h3>Installation</h3>
+<ul>
+ <li><a href="installation_release.html">Installing the latest release</a>
+ <li><a href="installation_source.html">Building from source code</a>
+ <li><a href="installation_develop.html">Building the development version</a>
+</ul>
+
+<hr>
+<h3>Manual</h3>
+<ul>
+ <li><a href="guide.html">Player Guide</a> <span class="superscript">needs updating</span>
+ <li><a href="manual.html">User Manual</a> <span class="superscript">needs updating</span>
+ <li><a href="starsystem_roadmap.html">Starsystem Roadmap</a>
+ <li><a href="storyline.html">Storyline</a> <span class="superscript">todo</span>
+</ul>
+
+<hr>
+<h3>Editing</h3>
+<ul>
+ <li><a href="world.html">Editing the world</a> <span class="superscript">needs updating</span>
+ <li><a href="models.html">Creating models</a> <span class="superscript">needs updating</span>
+</ul>
+
+<hr>
+<h3>General information</h3>
+<ul>
+ <li><a href="#internet">Internet</a>
+ <li><a href="#development">Development</a>
+ <li><a href="#team">Team</a>
+ <li><a href="#contributers">Contributors</a>
+ <li><a href="#credits">Credits</a>
+ <li><a href="attributions.html">Attributions</a>
+ <li><a href="#copyright">Copyright</a>
+ <li><a href="#acknowledgements">Acknowledgements</a>
+</ul>
+
+
+<!-- Internet ====================================================== -->
+
+<h2 id="internet">Internet</h2>
-<div id="internet" class="title">
- Internet
-</div>
-<div class="text">
<p>
The website for Project::OSiRiON can be found at
<a href="http://osirion.org">http://osirion.org</a>
</p>
<p>
+ The community forums can be foudn at
+ <a href="http://osirion.org/forum">http://osirion.org/forum</a>
+</p>
+<p>
The official IRC channel is <a href="irc://chat.freenode.net/%23osirion">#osirion</a> on the
<a href="http://freenode.net/">FreeNode</a> IRC network.
</p>
+
+<!-- Development =================================================== -->
+
+<h2 id="development">Development</h2>
<p>
SVN activity is monitored by <a href="http://cia.vc/">CIA.vc</a>, the project pages can be found here:
<ul>
@@ -84,77 +130,104 @@
<li><a href="http://cia.vc/stats/project/osirion-data">osirion-data</a>
</ul>
</p>
-</div>
-
-<div id="copyright" class="title">
- Copyright
-</div>
-<div class="text">
-<p>
- 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 game data is distributed under the terms and conditions of the
- <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative 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.
+ The repositories can also be viewed online:
+ <ul>
+ <li><a href="http://osirion.org/viewvc/index.cgi/osirion/">osirion</a>
+ <li><a href="http://osirion.org/viewvc/index.cgi/osirion-data/">osirion-data</a>
+ <li><a href="http://osirion.org/viewvc/index.cgi/osirion-data-src/">osirion-data-src</a>
+ </ul>
</p>
<p>
- Copyright &copy; 2007-2011, Stijn 'Ingar' Buys &lt;ingar@telenet.be&gt;
-</p>
-</div>
-
+ The project development roadmap and an overview of open issues can be found on the
+ <a class="osirionmenu" href="http://osirion.org/tracker/">tracker</a>.
-<div id="team" class="title">
- Team
-</div>
+<!-- Team ========================================================== -->
-<div class="text">
- <table>
+<h2 id="team">Team</h2>
+<p>
+ The core team, these people work on the game and decide about its future:
+</p>
+<table class="fullwidth">
<tr>
- <td>Stijn 'Ingar' Buys</td>
- <td>Programming, modeling, graphics, sounds</td>
+ <td class="quarterwidth">Stijn 'Ingar' Buys</td>
+ <td>Programming, modeling, graphics, sound</td>
</tr>
<tr>
- <td>Michael 'Thorn' Rodenhurst</td>
+ <td class="quarterwidth">Michael 'Thorn' Rodenhurst</td>
<td>Modeling, graphics, web server</td>
</tr>
<tr>
- <td>Evan 'Mega' Goers</td>
+ <td class="quarterwidth">Evan 'Mega' Goers</td>
<td>Modeling, graphics</td>
</tr>
- </table>
-</div>
+</table>
-<div id="contributors" class="title">
- Contributors
-</div>
-<div class="text">
- <table>
+<!-- Contributors ================================================== -->
+
+<h2 id="contributers">Contributors</h2>
+
+<p>
+ These people created new content for the game:
+</p>
+
+<table class="fullwidth">
<tr>
- <td>Cody 'Supertanker' Jackson</td>
+ <td class="quarterwidth">Cody 'Supertanker' Jackson</td>
<td>Modeling</td>
</tr>
<tr>
- <td>Antti 'Karvajalka' Lahti</td>
+ <td class="quarterwidth">Antti 'Karvajalka' Lahti</td>
<td>Modeling, graphics</td>
</tr>
+</table>
- </table>
-</div>
+<!-- Credits ======================================================= -->
+
+<h2 id="credits">Credits</h2>
+
+<p>
+ People who made their existing work available:
+</p>
+
+<table class="fullwidth">
+ <tr>
+ <td><a href="http://www.kurotorobert.com/">Robert Kuroto</a></td>
+ </tr><tr>
+ <td><a href="http://trak.mercenariesguild.net/">Georges 'TRaK' Grondin</a></td>
+ </tr><tr>
+ <td><a href="http://www.celestiamotherlode.net/catalog/show_creator_details.php?creator_id=5">Jeremy 'Jestr' Gardner</a></td>
+ </tr><tr>
+ <td><a href="http://www.celestiamotherlode.net/catalog/show_creator_details.php?creator_id=153">Chance Ragen</a></td>
+ </tr><tr>
+ <td><a href="http://www.jpl.nasa.gov/">NASA Jet Propulsion Laboratory</a></td>
+ </tr>
+</table>
+
+<!-- Copyright ===================================================== -->
+
+<h2 id="copyright">Copyright</h2>
+
+<p>
+ 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 game data is distributed under the terms and conditions of the
+ <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0 License</a>.
+</p>
+<p>
+ Copyright &copy; 2007-2012, Project::OSiRiON
+</p>
+
+<!-- Acknowledgements ============================================== -->
+
+<h1 id="acknowledgements">Acknowledgements</h1>
-<div id="acknowledgements" class="title">
- Acknowledgements
-</div>
-<div class="text">
<p>
This project could not have been possible without the work of others:
<ul>
@@ -192,6 +265,25 @@
and is not affiliated with these companies.
</p>
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
+</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+
+</div>
</body>
</html>
diff --git a/doc/installation.html b/doc/installation.html
index 4cd386e..20464f1 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -7,6 +7,7 @@
</head>
<body>
+<!--
<div class="banner">
<img src="images/banner.png" ALT="Project::OSiRiON">
<br>
@@ -497,7 +498,7 @@ Organization of the distribution
/gtkradiant radiant support files
</pre>
-</div>
+</div>-->
</body>
</html>
diff --git a/doc/installation_develop.html b/doc/installation_develop.html
new file mode 100644
index 0000000..de03251
--- /dev/null
+++ b/doc/installation_develop.html
@@ -0,0 +1,347 @@
+<!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">
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Building the development version</title>
+</head>
+
+<body>
+<div id="page">
+
+<!-- header and menu ======================================= -->
+
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
+
+<div id="content">
+
+<h1>Building the development version<h1>
+
+<p>
+ The latest release is usually lagging behind current development. If you want to check
+ the latest developments for yourself, you can get the most recent source code and game
+ data from the subversion repository.
+</p>
+<p>
+ Building the development version is very similar to <a href="installation_source.html">building
+ from source code</a>. The system requirements still apply. Additionally you will need
+ a subversion client.
+</p>
+ <ul>
+ <li><a href="#download_source">Obtaining the source code</a>
+ <li><a href="#download_data">Obtaining the game data</a>
+ <li><a href="#configure">Configuring the source code</a>
+ <li><a href="#building">Building the binaries</a>
+ <li><a href="#running">Running</a>
+ <li><a href="#updating">Updating</a>
+ <li><a href="#source_data">Source data (optional)</a>
+ <li><a href="#radiant_support">Radiant support files (optional)</a>
+ <li><a href="#organization">Organization of the distribution</a>
+ </ul>
+</p>
+
+
+<!-- Obtaining the source code ===================================== -->
+
+<h2 id="download_source">Obtaining the source code</h2>
+
+<p>
+ On linux, you can use the Subversion command line client tool. The following
+ command will create a new subdirectory <span class="fixed">osirion</span> and download the source code into it.
+</p>
+<div class="fixed">
+ svn checkout svn://osirion.org/osirion osirion
+</div>
+<p>
+ On windows, you can use the Turtoisesvn SubVersion client to access the
+ SVN repositories. You can download it here:
+</p>
+<ul>
+ <li><a href="http://tortoisesvn.tigris.org">http://tortoisesvn.tigris.org</a>
+</ul>
+<p>
+ Enter the new directory:
+</p>
+<div class="fixed">
+ cd osirion
+</div>
+
+<!-- Obtaining the game data ======================================= -->
+
+<h2 id="download_data">Obtaining the game data</h2>
+<p>
+ The game data should be located in the <span class="fixed">data</span> subdirectory of the main distribution.
+ You can use the game data package from the website or get it from the osirion-data subversion repository:
+ <ul>
+ <li><a href="svn://osirion.org/osirion-data">svn://osirion.org/osirion-data</a>
+ </ul>
+</p>
+<p>
+ Run the following command from within the main distribution directory to download
+ the game data into the <span class="fixed">data</span> subdirectory:
+</p>
+<div class="fixed">
+ svn checkout svn://osirion.org/osirion-data data
+</div>
+
+<!-- Configuring the source code =================================== -->
+
+<h2 id="configure">Configuring the source code</h2>
+<p>
+ Create the configure script:
+</p>
+<div class="fixed">
+ autoreconf -fi
+</div>
+<p>
+ Create a build directory, If something goes wrong, or building doesn't work any more after updating,
+ you can just delete the build directory and start over without destorying the working copy.
+ Enter the build directory and configure the source code:
+</p>
+<div class="fixed">
+ mkdir build<br>
+ cd build<br>
+ ../configure --with-bullet=/usr/local --enable-static-bullet
+</div>
+<p>
+ Use the <span class="fixed">--help</span> option to get a list of all available options:
+</p>
+<div class="fixed">
+ ../configure --help
+</div>
+
+<!-- Building the binaries ========================================== -->
+
+<h2 id="building">Building the binaries</h2>
+<p>
+ Compile the source code:
+</p>
+<div class="fixed">
+ make -j2
+</div>
+<p>
+ The <span class="fixed">-j2</span> options tells make to use two threads while building, if you have a
+ quad-core cpu, you can use <span class="fixed">-j4</span>.
+</p>
+<p>
+ The binaries will be built in the <span class="fixed">src/</span> subdirectory of the build directory.
+</p>
+<p>
+ <b>Important</b>:<br>
+ <span class="fixed">make install</span> is not supported. Results are unpredictable.
+</p>
+<p>
+ Leave the build directory:
+</p>
+<div class="fixed">
+ cd ..
+</div>
+
+<!-- Running ======================================================= -->
+
+<h2 id="running">Running</h2>
+<p>
+ The client and the dedicated server will look for game data in the <span class="fixed">data</span> subdirectory
+ of the current working directory. Since the binaries are build in the <span class="fixed">src</span> you will
+ have start them with the <span class="fixed">src/</span> prefix.
+</p>
+<p>
+ To start the client:
+</p>
+<div class="fixed">
+ ./build/src/osirion
+</div>
+<p>
+ If the client opens a new window and immediatly close it again, it probably could not find
+ the game data and exited. Check your installation.
+</p>
+<p>
+ To start the dedicated server:
+</p>
+<div class="fixed">
+ ./build/src/osiriond
+</div>
+<p>
+ If you are using windows, the binaries will be called <span class="fixed">osirion.exe</span> and <span class="fixed">osiriond.exe</span>.
+</p>
+
+<!-- Updating ====================================================== -->
+
+<h2 id="updating">Updating</h2>
+<p>
+ Once you downloaded the source code and the game data from 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>
+<p>
+ Update the source code:
+</p>
+<div class="fixed">
+ cd osirion<br>
+ cd build<br>
+ make clean<br>
+ cd ..<br>
+ svn update
+</div>
+<p>
+ Update the game data:
+</p>
+<div class="fixed">
+ cd data<br>
+ svn update<br>
+ cd ..
+</div>
+<p>
+ Rebuild the binaries:
+</p>
+<div class="fixed">
+ autoreconf<br>
+ cd build<br>
+ ../configure --with-bullet=/usr/local --enable-static-bullet<br>
+ make -j2<br>
+ cd ..
+</div>
+
+<!-- Source data =================================================== -->
+
+<h1 id="source_data">Source data (optional)</h1>
+<p>
+ There is a seperate repository for files that are used to
+ create the game data, like blender, gimp or vector graphics files.
+ It is not necessary to download these files to play the game,
+ but if you are interested in contributing to the game you
+ might want to get them.
+</p>
+<p>
+ To download the source data from the subversion repository:
+</p>
+<div class="fixed">
+ svn checkout svn://osirion.org/osirion-data-src data-src
+</div>
+
+<!-- Radiant support files ========================================= -->
+
+<h1 id="radiant_support">Radiant support files (optional)</h1>
+<p>
+ You can skip this section if you do not intent to create models with netradiant or
+ gtkradiant 1.5. These files probably won't work with other versions. You can find precompiled
+ netradiant packages here:
+ <ul>
+ <li><a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a>
+ </ul>
+<p>
+ These instructions assume gtkradiant is installed in the directory
+ <span class="fixed">/usr/local/games/netradiant</span>. If it is installed in a different
+ directory on your system, edit these instructions accordingly.
+<p>
+ Copy the support files to the gtkradiant folder:
+</p>
+<div class="fixed">
+ cd data<br>
+ cd gtkradiant<br>
+ cp -vr * /usr/local/games/netradiant
+</div>
+<p>
+ Open the file <span class="fixed">/usr/local/games/netradiant/games/osirion.game</span> in
+ your favourite editor. Look for a line that begins with:
+</p>
+<div class="fixed">
+ enginepath_linux=
+</div>
+<p>
+ Make sure it points to your osirion data directory. For example,
+ if you checked out the source code into <span class="fixed">/home/user/osirion</span>,
+ then the data will be in <span class="fixed">/home/user/osirion/data</span> and
+ the line should look like this:
+</p>
+<div class="fixed">
+ enginepath_linux="/home/user/osirion/data"
+</div>
+<p>
+ Save the changes.
+</p>
+
+<!-- Organization of the distribution ============================== -->
+
+<h1 id="organization">Organization of the distribution</h1>
+
+<pre>
+/doc Documentation
+
+ index.html Documentation content
+ attributions.html List of game data attributions
+ installation_release.html Installing the latest release
+ installation_source.html Building from source code
+ installation_develop.html Building the development version (this file)
+ guide.html Player guide
+ manual.html User manual
+
+/src C++ source code
+
+ /audio audio library
+ /auxiliary auxiliary functions
+ /client osirion client
+ /core game-independent core library
+ /dedicated osiriond dedicated server
+ /filesystem filesystem library
+ /game game-specific functions
+ /base base game module
+ /example example game module
+ /intro intro game module
+ /math mathematical classes and functions
+ /sys low-level system functions
+ /render render library
+ /ui user interface library
+
+/data Data files
+
+ /base game data files
+ /bitmaps essential textures
+ /ini game world definitions
+ /maps 3D models (.map format)
+ /materials material definitions
+ /models 3D models (.ase and .obj format)
+ /particles particle definitions
+ /textures game world textures
+
+ /gtkradiant radiant support files
+</pre>
+
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
+</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+
+</div>
+</body>
+</html>
diff --git a/doc/installation_release.html b/doc/installation_release.html
new file mode 100644
index 0000000..39554bf
--- /dev/null
+++ b/doc/installation_release.html
@@ -0,0 +1,138 @@
+<!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">
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Installing the latest release</title>
+</head>
+
+<body>
+<div id="page">
+
+<!-- header and menu ======================================= -->
+
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
+
+<div id="content">
+
+<!-- System requirements =================================== -->
+
+<h1>Installing the latest release</h1>
+<p>
+ Before you can run the game, you must have working OpenGL libraries.
+ These are usually installed by the driver package for your videocard.
+</p>
+<p>
+ You can find the latest release in the downloads section of the website:<br>
+ <a href="http://osirion.org/index.php?page=downloads">http://osirion.org/index.php?page=downloads</a>
+</p>
+
+<!-- Windows =============================================== -->
+
+<h2>Windows</h2>
+<p>
+ Download for 32-bit windows<br>
+ <a href="http://osirion.org/files/osirion-latest-win32.zip">osirion-latest-win32.zip</a> (32-bit)<br>
+ This package should work on most windows systems.
+</p>
+ Download for 64-bit windows<br>
+ <a href="http://osirion.org/files/osirion-latest-win64.zip">osirion-latest-win64.zip</a> (64-bit)<br>
+</p>
+<p>
+ Dowload the game data package:<br>
+ <a href="http://osirion.org/files/osirion-latest-data.zip">osirion-latest-data.zip</a><br>
+</p>
+<p>
+ Unzip the executables package to an approriate directory. Unzip the game data package
+ in the new directory. For example, if the game was unzipped to
+ <span class="fixed">D:\Osirion</span> then there should be
+ a directory <span class="fixed">D:\Osirion\data\base</span> containing the game data.
+</p>
+<p>
+ Open the game directory in explorer and click on <span class="fixed">osirion.exe</span> to start the client.
+</p>
+
+<!-- Linux ================================================= -->
+
+<h2 id="linux">Linux</h2>
+<p>
+ Requirements:<br>
+ To run the client, tour system will need to have the following packages installed: libSDL, libjpeg, libpng and libz.
+ To run the dedicated server you need libz and ncurses. These are common packages and most systems will already have them installed.
+ You do not need to have the bullet libraries installed.
+</p>
+<p>
+ Linux download:<br>
+ <a href="http://osirion.org/files/osirion-latest-linux.tar.bz2">osirion-latest-linux.tar.bz2</a> (32- and 64-bit)<br>
+ This package contains the linux version of the client and the server.
+</p>
+<p>
+ Extract the package, a new subdirectory will be created. The actual directory name will depend on
+ the version number. Enter the new subdirectory.
+</p>
+<pre>
+tar jxvf osirion-latest-linux.tar.bz2
+cd osirion-linux-875
+</pre>
+<p>
+ Dowload the game data package:<br>
+ <a href="http://osirion.org/files/osirion-latest-data.zip">osirion-latest-data.zip</a><br>
+</p>
+<p>
+ Unzip it:
+</p>
+<pre>
+unzip ../osirion-latest-data.zip
+</pre>
+<p>
+ To run the 32 bit client:
+</p>
+<pre>
+./osirion.x86
+</pre>
+<p>
+ To run the 64 bit client:
+</p>
+<pre>
+./osirion.x86_64
+</pre>
+
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
+</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+
+</div>
+</body>
+</html>
+
diff --git a/doc/installation_source.html b/doc/installation_source.html
new file mode 100644
index 0000000..a8c4be2
--- /dev/null
+++ b/doc/installation_source.html
@@ -0,0 +1,276 @@
+<!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">
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Building from source code</title>
+</head>
+
+<body>
+<div id="page">
+
+<!-- header and menu ======================================= -->
+
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
+
+<div id="content">
+
+<h1>Building from source code<h1>
+
+<p>
+ To build Project::OSiRiON from source code you need a working C++ compiler
+ and have the necessary libraries and header files installed.
+ The official binaries are compiled with gcc on linux, and mingw on windows.
+ <ul>
+ <li><a href="#requirements">Requirements</a>
+ <li><a href="#building_ubuntu">Building on Ubuntu Linux</a>
+ <li><a href="#building_windows">Building on Windows</a>
+ <li><a href="#building_bullet">Builiding the Bullet physics library</a>
+ <li><a href="#download_source">Obtaining the source code</a>
+ <li><a href="#configure">Configuring the source code</a>
+ <li><a href="#building">Building the binaries</a>
+ <li><a href="#download_data">Obtaining the game data</a>
+ <li><a href="#running">Running</a>
+
+ </ul>
+</p>
+
+<!-- System requirements =================================== -->
+
+<h2 id="requirements">Requirements</h2>
+
+<p>
+ The following packages are required to build the the dedicated server:
+</p>
+<ul>
+ <li>zlib
+ <li><a href="http://www.bulletphysics.com/">Bullet physics library</a>
+ <li>ncurses or pdcurses (optional)
+</ul>
+<p>
+ Additionally, the client requires:
+</p>
+<ul>
+ <li>libjpeg
+ <li>libpng
+ <li>libSDL 1.2
+ <li>OpenGL
+ <li>OpenAL or OpenAL Soft
+ <li>Ogg Vorbis
+</ul>
+<p>
+ You will also need gcc, GNU make, automake and libtool.
+</p>
+
+
+<!-- Building on Ubuntu Linux ============================== -->
+
+<h2 id="building_ubuntu">Building on Ubuntu Linux</h2>
+
+<p>
+ To build the game on Ubuntu, you can install the required tools and dependencies by running the following commands in a terminal window:
+</p>
+<pre>
+sudo su -
+apt-get install autoconf automake libtool subversion
+apt-get install libjpeg8 libjpeg8-dev
+apt-get install libpng3 libpng3-dev
+apt-get install libvorbisfile3 libvorbis-dev
+apt-get install libglu1-mesa-dev
+apt-get install libopenal1 libopenal-dev
+apt-get install libsdl1.2debian libsdl1.2-dev
+</pre>
+
+<!-- Building on Windows =================================== -->
+
+<h2 id="building_windows">Building on Windows</h2>
+
+<p>
+ You can build the game on windows using a MinGW/MSYS environment. You can use
+ the instructions in <a href="http://ingar.satgnu.net/devenv/mingw32/">this document</a>
+ to create a complete environment, capable of building the Project::OSiRiON source code.
+ You need to install the base system described in part one,
+ and the following packages described in part two:
+ pkg-config, DirectX development files, zlib, SDL, libpng, libjpeg, OpenAL Soft,
+ libogg, libvorbis, pdcurses and bullet.
+</p>
+
+<!-- Building the Bullet physics library =========================== -->
+
+<h2 id="building_bullet">Building the Bullet physics library</h2>
+
+<p>
+ The engine uses the <a href="http://www.bulletphysics.com/">Bullet Physics Library</a>
+ for physics support. You can download the bullet source code here:
+ <ul>
+ <li><a href="http://code.google.com/p/bullet/downloads/list">http://code.google.com/p/bullet/downloads/list</a>
+ </ul>
+</p>
+<p>
+ To download and install the library:
+</p>
+<pre>
+wget http://bullet.googlecode.com/files/bullet-2.79-rev2440.tgz
+tar zxvf bullet-2.79-rev2440.tgz
+cd bullet-2.79
+./autogen.sh
+./configure --prefix=/usr/local --disable-demos
+make
+sudo make install
+cd ..
+</pre>
+<p>
+ If you do not want to install bullet in <span class="fixed">/usr/local</span>,
+ you can edit the <span class="fixed">--prefix</span> option here.
+ Edit the the <span class="fixed">--with-bullet</span> option
+ when configuring the Project::OSiRiON source code accordingly.
+</p>
+<p>
+ It is recommended you use this specific version of the library,
+ physics behaviour could be different in other versions.
+</p>
+
+<!-- Obtaining the source code ===================================== -->
+
+<h2 id="download_source">Obtaining the source code</h2>
+
+<p>
+ Download the source package from the website:
+</p>
+<ul>
+ <li><a href="http://osirion.org/files/osirion-latest-src.tar.bz2">osirion-latest-src.tar.bz2</a>
+</ul>
+<p>
+ Unzip the package into a directory of your liking and enter the new directory:
+</p>
+<div class="fixed">
+ wget http://osirion.org/files/osirion-0.2.1-svn1082-src.tar.bz2<br>
+ tar xf osirion-0.2.1-svn1082-src.tar.bz2<br>
+ cd osirion-0.2.1-svn1082-src<br>
+</div>
+
+<!-- Configuring the source code =================================== -->
+
+<h2 id="configure">Configuring the source code</h2>
+<p>
+ Enter the new directory and configure the source code:
+</p>
+<pre>
+./configure --with-bullet=/usr/local --enable-static-bullet
+</pre>
+<p>
+ If you do not need the client and want to build the dedicated server only you can pass
+ the <span class="fixed">--without-client</span> option to configure:
+</p>
+<pre>
+./configure --with-bullet=/usr/local --enable-static-bullet --without-client
+</pre>
+<p>
+ 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 <span class="fixed">--without-curses</span> option to configure.
+</p>
+<pre>
+./configure --with-bullet=/usr/local --enable-static-bullet --without-client --without-curses
+</pre>
+<p>
+ You can use the <span class="fixed">--help</span> option to get a list of all available options:
+</p>
+<pre>
+./configure --help
+</pre>
+
+<!-- Building the binaries ========================================== -->
+
+<h2 id="building">Building the binaries</h2>
+<p>
+ Compile the source code:
+</p>
+<pre>
+make
+</pre>
+<p>
+ The binaries will be built in the <span class="fixed">src/</span> subdirectory of the main distribution.
+</p>
+<p>
+ <b>Important</b>: <span class="fixed">make install</span> is not supported. Results are unpredictable.
+</p>
+
+<!-- Obtaining the game data ======================================= -->
+
+<h2 id="download_data">Obtaining the game data</h2>
+<p>
+ Download the game data package from the website:
+</p>
+<ul>
+ <li><a href="http://osirion.org/files/osirion-latest-data.zip">osirion-latest-data.zip</a>
+</ul>
+<p>
+ Unzip the package into the osirion directory.
+ The game data should be located in the <span class="fixed">data/</span> subdirectory of the main distribution.
+</p>
+
+<!-- Running ======================================================= -->
+
+<h2 id="running">Running</h2>
+<p>
+ The client and the dedicated server will look for game data in the <span class="fixed">data</span> subdirectory
+ of the current working directory. Since the binaries are build in the <span class="fixed">src</span> you will
+ have start them with the <span class="fixed">src/</span> prefix.
+</p>
+<p>
+ To start the client:
+</p>
+<pre>
+src/osirion
+</pre>
+<p>
+ If the client opens a new window and immediatly close it again, it probably could not find
+ the game data and exited. Check your installation.
+</p>
+<p>
+ To start the dedicated server:
+</p>
+<pre>
+src/osiriond
+</pre>
+<p>
+ If you are using windows, the binaries will be called <span class="fixed">osirion.exe</span> and <span class="fixed">osiriond.exe</span>.
+</p>
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
+</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+
+</div>
+</body>
+</html>
diff --git a/doc/osirion.css b/doc/osirion.css
new file mode 100755
index 0000000..e6ce165
--- /dev/null
+++ b/doc/osirion.css
@@ -0,0 +1,282 @@
+/*
+ main stylesheet for the Project::OSiRiON website
+ ingar@telenet.be
+*/
+
+/*
+ global defaults
+*/
+
+body {
+ background-image: url('images/background.jpg');
+ background-color: #000000;
+ background-repeat: no-repeat;
+ background-position: center top;
+ font-family: "DejaVu Sans", "BitStream Vera Sans", "sans-serif";
+ text-align: center;
+ font-size: 12pt;
+ color: #c0c0c0;
+ padding: 0;
+}
+
+img {
+ border: 0px;
+}
+
+a:link
+{
+ color: #fbff99;
+ text-decoration: none;
+}
+a:visited
+{
+ color: #c6c978;
+ text-decoration: none;
+}
+a:hover
+{
+ text-decoration: underline;
+}
+
+#content p {
+ padding-left: 8px;
+}
+
+#content dl {
+ padding-left: 8px;
+}
+
+#content dt {
+ font-weight: bold;
+ color: white;
+}
+
+#content dd {
+ padding-top: 4px;
+ padding-bottom: 4px;
+}
+
+#content h1 {
+ color: #ffffff;
+ font-size: 14pt;
+ font-weight: bold;
+}
+
+#content h2 {
+ color: #ffffff;
+ font-size: 12pt;
+ font-weight: bold;
+}
+
+#content h3 {
+ color: #ffffff;
+ font-size: 12pt;
+ font-style: italic;
+}
+
+#content table {
+ padding-left: 8px;
+}
+
+#content td {
+ padding-right: 16px;
+ vertical-align: top;
+}
+
+#content hr {
+ border: 0px;
+ height: 2px;
+ background-color: #808080;
+ color: #808080;
+}
+
+/* from the wiki theme css */
+#content ul {
+ line-height: 1.5em;
+ list-style-type: square;
+ margin: .3em 0 0 1.5em;
+ padding: 0;
+ list-style-image: url(images/bullet.png);
+}
+/*
+ global div definitions
+*/
+
+div.floatright {
+ text-align: center;
+ vertical-align: middle;
+ margin-left: auto;
+ margin-right: 8px;
+ margin-top: 8px;
+ margin-bottom: auto;
+ float: right;
+}
+
+div.newsitem {
+ color: #ffffff;
+ font-size: 12pt;
+ font-weight: bold;
+}
+
+div.newsdate {
+ color: #ffffff;
+ font-family: "Courier New", "Courier", "fixed", "monospace";
+ font-size: 10pt;
+}
+
+div.newstext {
+ font-size: 12pt;
+}
+
+table.screenshot {
+ text-align: center;
+ font-family: "Courier New", "Courier", "fixed", "monospace";
+ margin-left:auto;
+ margin-right:auto;
+}
+
+td.screenshot {
+ text-align: center;
+ font-size: 10pt;
+}
+
+img.screenshot {
+ vertical-align: top;
+ padding: 16px;
+ clear: both;
+}
+
+/*
+ page structure
+*/
+
+div#page {
+ background-color: #000000;
+ margin-top: 16px;
+ margin-right: 8%;
+ margin-left: 8%;
+ margin-bottom: 32px;
+ width: 84%;
+ padding-left: 0px;
+ padding-right: 0px;
+
+ border: 2px solid #505050;
+}
+
+/*
+ menu
+*/
+
+table.osirionmenu {
+ text-align: center;
+ margin: 0px;
+ margin-bottom: 16px;
+ margin-top: 16px;
+ padding: 0px;
+}
+
+td.osirionmenu {
+ text-align: center;
+ font-size: 10pt;
+ font-weight: bold;
+ border-top: 1px solid #808080;
+ border-bottom: 1px solid #808080;
+ background-color: #202020;
+ padding: 8px;
+ margin: 0px;
+}
+
+a.osirionmenu {
+ color: #fbff99;
+}
+
+a.osirionmenu:visited {
+ color: #fbff99;
+}
+
+a.osirioncurrent {
+ color: #ffffff;
+}
+
+a.osirioncurrent:visited {
+ color: #ffffff;
+}
+
+
+img.osirionmenu {
+ margin: 0px;
+ margin-bottom: 12px;
+}
+
+
+/*
+ content
+*/
+
+div#content {
+ text-align: left;
+ margin-bottom: 32px;
+ padding-left: 16px;
+ padding-right: 16px;
+}
+
+.fullwidth {
+ width: 100%;
+ vertical-align: top;
+}
+
+.halfwidth {
+ width: 50%;
+ vertical-align: top;
+}
+
+.quarterwidth {
+ width: 25%;
+ vertical-align: top;
+}
+
+
+/*
+ misc style elements
+*/
+
+.superscript {
+ color: #ff0000;
+ vertical-align: top;
+ font-size: 8pt;
+}
+
+.fixed {
+ font-family: "Courier New", "Courier", "fixed";
+ font-size: 12pt;
+}
+
+#content pre, div.fixed {
+ border-top: 1px solid #808080;
+ border-bottom: 1px solid #808080;
+ border-left: 1px solid #808080;
+ border-right: 1px solid #808080;
+ background-color: #202020;
+ margin-left: 48px;
+ margin-right: 48px;
+ margin-top: 8px;
+ margin-bottom: 8px;
+ padding: 8px;
+ font-family: "Courier New", "Courier", "fixed";
+ font-size: 12pt;
+ vertical-align: text-top;
+}
+
+/*
+ footer
+*/
+
+div#footer {
+ text-align: left;
+ font-size: 8pt;
+ padding-top: 0px;
+ padding-left: 16px;
+ height: 48px;
+ border-top: 1px solid #808080;
+ background-color: #202020;
+}
diff --git a/doc/starsystem_roadmap.html b/doc/starsystem_roadmap.html
new file mode 100644
index 0000000..207fd18
--- /dev/null
+++ b/doc/starsystem_roadmap.html
@@ -0,0 +1,69 @@
+<!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">
+ <meta name="keywords" content="free, open, source, osirion, game, space, freelancer, privateer, opengl, radiant">
+ <link rel="stylesheet" type="text/css" href="osirion.css">
+ <link rel="icon" type="image/png" href="http://osirion.org/icon.png">
+ <title>Project::OSiRiON - Attributions</title>
+</head>
+
+<body>
+<div id="page">
+
+<!-- header and menu ======================================= -->
+
+<table class = "osirionmenu" width="100%" cellpadding="0" cellspacing="0" border="0">
+<tr>
+ <td>
+ <a href="http://osirion.org"><img class="osirionmenu" src="images/banner.png" alt="Project::OSiRiON"></a>
+ </td>
+</tr><tr>
+ <td class="osirionmenu">
+ <a class="osirionmenu" href="http://osirion.org/">Home</a> .
+ <a class="osirionmenu" href="http://osirion.org/index.php?page=downloads">Downloads</a> .
+ <a class="osirioncurrent" href="index.html">Documentation</a> .
+ <a class="osirionmenu" href="http://osirion.org/forum/">Forum</a> .
+ <a class="osirionmenu" href="http://osirion.org/wiki/">Wiki</a> .
+ <a class="osirionmenu" href="http://osirion.org/tracker/">Tracker</a>
+ </td>
+</tr>
+</table>
+
+<div id="content">
+
+<!-- Starsystem roadmap ============================================ -->
+
+<h1>Starsystem roadmap</h1>
+
+<table class="screenshot">
+ <tr><td class="screenshot">
+ <a href="images/roadmap.png">
+ <img src="images/roadmap.png" width="640px">
+ </a>
+ </td></tr>
+</table>
+
+<!-- footer ================================================ -->
+
+</div> <!-- div content -->
+
+<div id="footer">
+
+<div class="floatright">
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict" height="31" width="88">
+ </a>
+</div>
+<p>
+ Copyright &copy; 2007-2012 Project::OSiRiON
+</p>
+</div> <!-- div id=footer> -->
+
+</div> <!-- div page> -->
+
+</div>
+</body>
+</html>
+
+