documentation updates

1 files changed, 182 insertions, 27 deletions

diff --git a/doc/installation.html b/doc/installation.html
index 1e34445..275da58 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -16,7 +16,13 @@
 	There are two ways to install the program and the game data. You can
 	either download a precompiled package from the website, or you
 	can obtain the source code and compile it yourself.
-<h2>
+<ul>
+	<li><a href="#precompiled">Downloading a precompiled package</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">
 	Downloading a precompiled package
 </h2>
 <p>
@@ -40,47 +46,45 @@
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-latest-linux.zip">osirion-latest-linux.zip</a><br>
 	This packages contains the linux x86 and x86_64 version of the server, the client and the game data.
 <p>
-	<i>The instructions will install the game in a subdirectory of your home directory</i>
-<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
-osirion-0.1_258-linux/
-osirion-0.1_258-linux/data/
-osirion-0.1_258-linux/data/base/
- ...
-osirion-0.1_258-linux/README
-osirion-0.1_258-linux/osiriond.x86
-osirion-0.1_258-linux/osirion.x86_64
-~$ cd osirion-0.1_258-linux/
-~/osirion-0.1_258-linux$
+tar jxvf osirion-latest.tar.bz2
+cd osirion-0.1_258-linux
 </pre>
 <p>
 	 To run the 32bit client:
 <pre>
-~/osirion-0.1_258-linux$ ./osirion.x86
+./osirion.x86
 </pre>
 <p>
 	 To run the 64bit client:
 <pre>
-~/osirion-0.1_258-linux$ ./osirion.x86_64
+./osirion.x86_64
 </pre>
-<h2>
-	Compiling from source code
+<h2 id="building_from_source">
+	Building from source code
 </h2>
 <h3>
 	Requirements
 </h3>
 <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:
-<table>
-	<tr><td>SDL</td><td>version 1.2 or newer</td></tr>
-	<tr><td>OpenGL</td><td>version 1.1 or newer</td></tr>
-	<tr><td>OpenAL</td><td>version 1.1 or newer</td></tr>
-	<tr><td>zlib</td><td></td></tr>
-</table>
+	the following libraries and their header files installed on your system.
+
+<p>
+	To build the client or the dedicated server:
+	<table>
+		<tr><td>zlib</td><td></td></tr>
+	</table>
+<p>
+	To build the client:
+	<table>
+		<tr><td>SDL</td><td>version 1.2 or newer</td></tr>
+		<tr><td>OpenGL</td><td>version 1.1 or newer</td></tr>
+		<tr><td>OpenAL</td><td>version 1.1 or newer</td></tr>
+	
+	</table>
 <p>
 	You will also need a recent version of gcc, GNU make, automake and libtool.
 <p>
@@ -96,10 +100,161 @@ osirion-0.1_258-linux/osirion.x86_64
 <h3>
 	Obtaining the source code
 </h3>
+<p>
+	You can download the osirion source code from the osirion subversion repository:<br>
+	<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a>
+<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>
+svn co svn://intranifty.no-ip.org/osirion
+</pre>
+<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>
+<p>
+	You can also get the source package from the website:<br>
+	<a href="http://ingar.satgnu.net/osirion/files/osirion-latest-src.tar.bz2">osirion-latest-src.tar.bz2</a>
+<h3>
+	Compiling the source code
+</h3>
+<p>
+	Enter the new directory and configure the source code:
+<pre>
+cd osirion
+autoreconf -fi
+./configure
+</pre>
+<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>
+./configure --without-client
+</pre>
+<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>.
+<p>
+	<b>Important</b>: <i>make install</i> is not supported. Results are unpredictable.
+<p>
+	Compile the source code:
+<pre>
+make
+</pre>
+<p>
+	The binaries will be build in the <i>src</i> subdirectory of the main distribution.
 <h3>
 	Obtaining the game data
 </h3>
-
+<p>
+	The game data should be located in the <i>data</i> subdirectory of the main distribution.
+	The data is not included with the source distribution. You will have to copy it from
+	a binary package or download it from the osirion-data subversion repository:<br>
+	<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion-data</a>
+<p>
+	Run the following command from within the main distribution directory to download
+	the game data into the <i>data</i> subdirectory:
+<pre>
+svn checkout svn://intranifty.no-ip.org/osirion-data data
+</pre>
 </body>
-
-</html>
\ No newline at end of file
+<h3>
+	Executing
+</h3>
+<p>
+	The client and the dedicated server look for the 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>
+	To start the client
+<pre>
+src/osirion
+</pre>
+<p>
+	To start the dedicated server
+<pre>
+src/osiriond
+</pre>
+<p>
+	Of you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
+<h3>
+	Updating
+</h3>
+<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 distclean
+svn update
+</pre>
+<p>
+	Update the game data:
+<pre>
+cd data
+svn update
+cd ..
+</pre>
+<p>
+	Rebuild the binaries:
+<pre>
+autoreconf
+./configure
+make
+</pre>
+<h2 id="gtkradiant">
+	GtkRadiant 1.5.0 support files (optional)
+</h2>
+<p>
+	You only need to install these files if you want to create models
+	with gtkradiant. Note that these files where made for 
+	gtkradiant 1.5.0, they probably won't work with other versions.
+	You can find precompiled gtkradiant 1.5.0 binaries for linux on my
+	gtkradiant page:<br>
+	<a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a>
+<p>
+	These instructions assume gtkradiant is installed in the directory
+	<i>/usr/local/games/gtkradiant-1.5.0</i>. If it is installed in a different 
+	directory on your system, edit these instructions accordingly.
+<p>
+	Copy the support files to the gtkradiant folder:
+<pre>
+cd data
+cd gtkradiant
+cp -vr * /usr/local/games/gtkradiant-1.5.0
+</pre>
+<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>
+enginepath_linux="
+</pre>
+<p>
+	Make sure it points to your osirion data directory. For example,
+	if you checked out the source code in <i>/home/user/osirion</i>, 
+	then the data will be in <i>/home/user/osirion/data</i> and 
+	the line should look like this:
+<pre>
+enginepath_linux="/home/user/games/osirion/data"
+</pre>
+<p>
+	Save the changes.
+<h2 id="source_data">
+	Source data (optional)
+</h2>
+<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>
+	To download the source data from the subversion repository:
+<pre>
+svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
+</pre>
+</html>