<!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> The Osirion Project - 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. <ul> <li><a href="#precompiled">Using precompiled executables</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> Windows </h3> <p> Download the windows executables 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. <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 the executables package into an approriate directory. Unzip the gama data package into this directory. For example, if you unzipped the data and the executables into <i>D:\Osirion</i> then there should be a directory <i>D:\Osirion\data\base</i> containing the game data. <p> Open the game directory in explorer and click on <i>osirion.exe</i> to start the client. <h3> Linux </h3> <p> Download the linux executables 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. <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 cd osirion-0.1_258-linux </pre> <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> unzip ../osirion-data-latest.zip </pre> <p> To run the 32bit client: <pre> ./osirion.x86 </pre> <p> To run the 64bit client: <pre> ./osirion.x86_64 </pre> <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. <p> To build the client or the dedicated server: <ul> <li>zlib </ul> <p> To build the client: <ul> <li>libSDL 1.2 <li>libpng <li>libjpeg-6b <li>OpenGL <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> 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> <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> 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 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-src-latest.tar.bz2">osirion-src-latest.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. 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> 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> <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 clean 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 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 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/yourname/osirion</i>, then the data will be in <i>/home/yourname/osirion/data</i> and the line should look like this: <pre> enginepath_linux="/home/yourname/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> <h2 id="organization"> Organization of the distribution </h2> <pre> /doc Documentation index.html Documentation content installation.html Installation instructions (this file) /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 /data Data files /base game data files /bitmaps essential bitmaps /ini game world description files /maps game world models /scripts gtkradiant shader files /textures game world textures /gtkradiant gtkradiant support files </pre> <h2 class="navigate"> <a href="index.html">back</a> </h2> </body> </html>