Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/installation.html')
-rw-r--r--doc/installation.html105
1 files changed, 105 insertions, 0 deletions
diff --git a/doc/installation.html b/doc/installation.html
new file mode 100644
index 0000000..1e34445
--- /dev/null
+++ b/doc/installation.html
@@ -0,0 +1,105 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+ <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
+ <link rel="stylesheet" type="text/css" href="style.css">
+ <TITLE>The Osirion Project - Installation</TITLE>
+</head>
+<body>
+
+<h1>
+ Installation
+</h1>
+<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
+ can obtain the source code and compile it yourself.
+<h2>
+ Downloading a precompiled package
+</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>
+ Windows
+</h3>
+<p>
+ Download the windows package:<br>
+ <a href="http://ingar.satgnu.net/osirion/files/osirion-latest-win32.zip">osirion-latest-win32.zip</a><br>
+ This packages contains the win32 version of the server, the client and the game data.
+<p>
+ Unzip the package to an approriate directory. Open the directory in explorer and
+ click on <i>osirion.exe</i> to start the client.
+<h3>
+ Linux
+</h3>
+<p>
+ Download the linux package:<br>
+ <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$
+</pre>
+<p>
+ To run the 32bit client:
+<pre>
+~/osirion-0.1_258-linux$ ./osirion.x86
+</pre>
+<p>
+ To run the 64bit client:
+<pre>
+~/osirion-0.1_258-linux$ ./osirion.x86_64
+</pre>
+<h2>
+ Compiling 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>
+<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:
+<table>
+ <tr><td>linux-x86_64</td><td>gcc 4.1.2</td></tr>
+ <tr><td>linux-i686</td><td>gcc 4.1.2</td></tr>
+ <tr><td>mingw32 </td><td>gcc 4.2.2</td></tr>
+</table>
+
+<h3>
+ Obtaining the source code
+</h3>
+<h3>
+ Obtaining the game data
+</h3>
+
+</body>
+
+</html> \ No newline at end of file