From b75d57ad691c2f1612ee430c2805d541703971de Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Mon, 14 Jul 2008 12:30:27 +0000 Subject: converting documentation to HTML --- doc/installation.html | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 doc/installation.html (limited to 'doc/installation.html') 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 @@ + + + + + + + The Osirion Project - Installation + + + +

+ Installation +

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

+ Downloading a precompiled package +

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

+ Windows +

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

+ Unzip the package to an approriate directory. Open the directory in explorer and + click on osirion.exe to start the client. +

+ Linux +

+ Download the linux package:
+ osirion-latest-linux.zip
+ This packages contains the linux x86 and x86_64 version of the server, the client and the game data. +

+ The instructions will install the game in a subdirectory of your home directory +

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

+~$ tar jxvf osirion-latest.tar.bz2
+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$
+

+ To run the 32bit client: +

+~/osirion-0.1_258-linux$ ./osirion.x86
+

+ To run the 64bit client: +

+~/osirion-0.1_258-linux$ ./osirion.x86_64
+

+ Compiling from source code +

+ Requirements +

+ To build The Osirion Project from source code you will need to have + the following libraries and their header files installed on your system: + + + + + +
SDL version 1.2 or newer
OpenGL version 1.1 or newer
OpenAL version 1.1 or newer
zlib
+

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

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

+ Obtaining the source code +

+ Obtaining the game data +

+ + + + \ No newline at end of file -- cgit v1.2.3

SDL	version 1.2 or newer
OpenGL	version 1.1 or newer
OpenAL	version 1.1 or newer
zlib