The Osirion Project - INSTALL

	These are the installation instructions for the Osirion Project.
	A description of theproject and general usage information can be
	found in the README file.

Installation

	To build the Osirion Project from source code you will need 
	the SDL and OpenGL library and header files.


	In theory, it should compile on any POSIX-compatible platform 
	supported by SDL, but at the time of writing only linux is 
	supported.

	I have succesfully compiled it on the following platforms:
		linux-x86_64, gcc 4.1.2, SDL 1.2.11 

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

	At present, 'make install' is neither tested nor supported.

Compiling the dedicated server only

	The included configure script is not yet capable of compiling the
	dedicated server only. If you want to compile the dedicated server
	on a system that does not have SDL or OpenGL, you will have to finish
	the build manually.

	Start the build in the usual fashion:

		cd osirion/
		autoreconf -fi
		./configure
		make

	When trying to build the render library, the build will fail with 
	an error message. Proceed by building the game library and the 
	osiriond binary:

		cd src/game
		make
		cd ..
		make osiriond
		cd ..

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 ..