The Osirion Project

	This is the Osirion project. I wrote it to get a better grasp on
	game design with opengl and to get some C++ practice.
	Maybe someday, it will be a real game.

	Read INSTALL for instructions on building and installing.

Dedicated server

	The dedicated server will accept incoming connections on port 8042.
	There is no server console.
	
Client

	Starting the client will show the loader screen.
	To start the game, open the client console with ~ and type 'connect'.
	You will join the game as spectator, type 'join' in the console
	to join the game. Type 'spectate' to spectate again.
	Type 'disconnect' to return to the loader screen.

	While joined, you can exchange your ship for a new one with 
	the 'buy' command.

	The client is capable of acting as a networked server. You can enable
	the private server by setting 'sv_private 1' before you 'connect'.

Controls

	~: toggle console
	space bar: switch camera mode
	left/right/up/down arrow keys: rotate camera in free mode
	keypad left/right: turn the ship left/right
	keypad +/-: increase/decrease forward thruster

Console functions

	The following commands are available on the console:

		connect		connect the client to the game module
		disconnect	disconnect the client from the game module
		list_ent	list registered entities
		list_func	list registered functions
		list_model	list regsitered models
		list_var	list registered variables
		quit		exit the application
		r_restart	restart the video subsystem

	The following commands are available when connected to a game:

		join		join the game
		spectate	spectate
		buy		switch your ship for a new one

	To change the video resolution, set the r_width and 
	r_height variables and execute r_restart.
	e.g.: to set the video mode to 1024x768 type:
		
		r_width 1024
		r_height 768
		r_restart

	To switch to fullscreen mode, set the r_fullscreen 
	variable to 1:

		r_fullscreen 1
		r_restart

	You can set your name and player color through the cl_color
	and cl_name variables. You will have to disconnect and reconnect
	for the changes to take effect:

		cl_name SpaceCowboy
		cl_color 1.0 1.0 0.0
		connect

	Settings are saved when you quit the application.

Organization of the distribution

	C++ source code

	/src

		/math			mathematical classes
		/sys			low-level system functions
		/filesystem		virtual filesystem library
		/core			game-independent core library
		/game			game-specific functions 
		/server			osiriond dedicated server
		/render			render library
		/client			osirion client

	Data files

	/data
		/base			game data files
			/bitmaps	essential bitmaps
			/maps		.map models
			/textures	textures
		/gtkradiant		gtkradiant support files
	
	The game data can be obtained as a seperate distribution.
	Refer to the file INSTALLATION for more information.

Acknowledgements

	This project could not have been possible without the work of others:

	Id Software, for releasing the quake source code, which obviously 
	acted as a example.

	Id Software and the GtkRadiant project contributers

	The Quake2World community

	The Satgnu crew

	Thanks to bobke, blaze-x and Thorn[mDc]

	A special thanks to all =KCT= members
	
License

	The program is distributed under the terms and conditions of the 
	GNU General Public License version 2.

	Copyright 2007-2008
	Ingar=KCT= <ingar@telenet.be>