diff options
Diffstat (limited to 'doc/INSTALL')
| -rw-r--r-- | doc/INSTALL | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/doc/INSTALL b/doc/INSTALL new file mode 100644 index 0000000..3f4bc75 --- /dev/null +++ b/doc/INSTALL @@ -0,0 +1,155 @@ + +The Osirion Project - INSTALL + + These are the installation instructions for the Osirion Project. + A description of the project and general usage information can be + found in the README file. + +Installation + + To build the Osirion Project from source code you will need + the following libraries and their header files: + + SDL version 1.2 or newer + OpenGL, version 1.1 or newer + OpenAL version 1.1 or newer + + I have succesfully compiled it on the following platforms: + + linux-x86_64 gcc 4.1.2 + linux-i686 gcc 4.1.2 + mingw32 gcc 4.2.2 + + In theory, it should compile on any POSIX-compatible platform + supported by SDL, reports for other platforms (working or not) + are welcome. + +Compilation on windows32 + + If you downloaded the zip file containing the windows32 + exe files, all the hard work has already been done and the + game is ready to run. If you want to build your own exe files, + keep on reading. + + You can use maci's excellent mingw/msys package to install + a development environment on windows. You can find the + installer here: + + http://satgnu.net/maci/files/q2wdevenv.exe + + You can use the Turtoisesvn SubVersion client to access the + SVN repositories. You can download it from + + http://tortoisesvn.tigris.org/ + +Obtaining the source code + + Get the latest version of the source code from svn: + + svn checkout svn://intranifty.no-ip.org/osirion + + This command will create a new subdirectory 'osirion' + and download the source code into it. + +Compiling the source code + + Enter the new directory and compile the source code: + + cd osirion/ + autoreconf -fi + ./configure + make + + If you only need to compile the dedicated server, you can + pass the --without-client option to configure: + + ./configure --without-client + + At present, 'make install' is neither tested nor supported. + +Installing game data + + The game data should be located in the 'data' + subdirectory of the main distribution. + + Get the latest version of the game data from svn: + Run the following command from within the main + distribution directory: + + svn checkout svn://intranifty.no-ip.org/osirion-data data + +Installing gtkradiant 1.5.0 support files (optional) + + 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, I have not tested the with any other version. + You can find precompiled gtkradiant 1.5.0 binaries for linux at + http://ingar.soliter.org. + + These instructions assume gtkradiant is installed in the directory + '/usr/local/games/gtkradiant-1.5.0'. If it is installed in a different + directory on your system, edit these instructions accordingly. + + Copy the support files to the gtkradiant folder: + + cd data + cd gtkradiant + cp -vr * /usr/local/games/gtkradiant-1.5.0 + + Open the file '/usr/local/games/gtkradiant-1.5.0/games/osirion.game' in + your favourite editor. Look for a line that begins with: + + enginepath_linux=" + + Make sure it points to your osirion data directory. For example, + if you checked out the source code in '/home/user/games/osirion', + then the data will be in '/home/user/games/osirion/data' and + the line should look like this: + + enginepath_linux="/home/user/games/osirion/data" + + Save the changes. + +Source data (optional) + + 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. + + To download the source data: + + svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src + +Executing + + To run the client program, execute: + + src/osirion + + To run the dedicated server, execute: + + src/osiriond + +Updating + + If you downloaded and compiled the game before, + there is no need to re-download the entire distribution. + + Update the game source code with the following commands: + + cd osirion/ + make distclean + svn update + + Rebuild the game: + + autoreconf -fi + ./configure + make + + Update the game data: + + cd data/ + svn update + cd .. |