------------------------------------------------------------
$Id: INSTALL,v 1.10 2003/03/23 20:41:32 mrq Exp $
------------------------------------------------------------


This documents describes the compilation process for a Unix based system
(this has been tested successfully on GNU/Linux only, but as it's been
written in a portable manner, porting it to another system should
only be a matter of tweaking the configure script).

NB: the Win32 compilation process is described in INSTALL.Win32

------------------------------------------------------------
1. What's needed ?
------------------------------------------------------------

Tools :
	* GNU make
	* C++ compiler, which supports namespaces, and templates (any
	  recent version of GCC under Linux and Windows, Visual C++ 6, etc.)
	* A bourne-compatible shell, and the common shell tools.

Libraries :
	* SDL, a library that handles sound, threads, window creation,
	  independently of the OS. Supported OSes are : Unix, BeOS, MacOS,
	  Windows, etc...
		http://www.libsdl.org 
		(also check out SDL_mixer. needed for sound/music)

	* VARIOUS STANDARD LIBRARIES
	  Those are zlib, libpng and libjpeg, they are normally installed with
	  a default installation.
	  Be aware that you also need to have their development counterparts
	  installed (with headers).

	* LUA LIBRARY
	  It can be downloaded from http://www.lua.org
	  It's very portable and straightforward to install.


	* OPENGL
	  OpenGL is the portable graphic library of Silicon Graphics, and is
	  normally installed on recent versions of any decent operating system.
	  If you don't have an OpenGL implementation for your graphic card,
	  you'd better call your vendor to ask where you can find one.

	  You can still run with software OpenGL, using Mesa by example. But
	  unless you have a _very_ fast processor, this will be too slow
	  to play any game. Anyway you can download Mesa from :
		http://www.mesa3d.org

------------------------------------------------------------
2. I've got everything, now how can I compile & run ?
------------------------------------------------------------

Five steps.

[Step 0:  Do that *only if you have downloaded the CVS version of Ark* 
	Run ./autogen.sh]

Step 1: Run ./configure --help. Check for the options you may need (to specify
	where libraries are installed, etc). If everything is in standard
	places there should be no problem. You can now run
	./configure [options]

Step 2: Just run : make

Step 3: If everything went right, you can use the "installer" (the purpose of
	which is to create a configuration file for Ark, in
	~/.arkhart/arkfactories.cfg, which is necessary for the shared
	library loader).
	
	./Docs/install.sh

Step 4:  You also need to have game data present on your hard disk, you can
	download them some http://arkhart.nekeme.net/?n=Arkhart/Download ;
	Be aware that you also need to "install" them (ie. run the install.sh
	script).

Step 5: You can now run the client, and enjoy !
	./Client/arkclient

If something goes wrong, file a bug in our bugzilla,
http://bugzilla.nekeme.net/, or contact us, either using
irc -- #arkhart @ irc.undernet.org -- or e-mail at staff@nekeme.net

