Round 3: Some minor cross-platform compatibility changes (FreeBSD), still may not...
[theoddone33/hhexen.git] / README
1 HHexen v1.3 README
2
3         HHexen is an enhanced Linux source port of the game Hexen by Raven Software. 
4 Its main purpose right now is to incorperate the assassin character class from 
5 Hexen 2 into the original Hexen.  Also, some minor enhancements are planned for
6 later versions. 
7         HHexen is based on the code for Linux Hexen by Karl Robillard.  Linux
8 Hexen can be found at http://www.raven-games.com/linuxhexen/
9
10 Features:
11
12         - New character class: the assassin from Hexen 2
13         - OpenGL rendering (thanks to Jaakko and Karl)
14         - Normal and inverse mouselook
15         - Higher in-game mouse sensitivity
16         - In-game key configuration
17
18 Installation:
19
20   X11 or SvgaLib:
21         No special tricks are required to compile these.  Just unpack the 
22   tarball and type "./configure".  If configure doesn't find any problems,
23   type either "make x11" or "make svgalib" and you should be all set.
24
25   OpenGL:
26         To compile for OpenGL, just run configure with the --enable-gl switch.
27   It will automatically check for the libGL.so and libGLU.so files, and if it
28   doesn't find them, it will use the MesaGL and MesaGLU libraries instead.  
29   If you want to use the MesaGL and MesaGLU libraries by default, run 
30   configure with the switch --enable-gl-mesa instead of --enable-gl.
31
32         It is very important that you run a "make clean" before compiling for
33   OpenGL if you have previously compiled for X11.  The same is true when 
34   compiling for X11 after previously compiling for OpenGL.
35         
36   Demo Wadfile:
37         If you don't have the full version of Hexen, you can still play HHexen.
38   The command for using the demo wad is "./configure --enable-demowad" and then
39   "make".  Note that if you are using OpenGL and the demo wad, you will need to
40   pass one of the arguments listed above to configure as well.
41
42 Contact:
43
44  Dan Olson - dolson@raven-games.com
45
46 Website:
47
48  http://www.raven-games.com/hhexen
49
50 Thanks:
51
52  Special thanks goes out to who have helped out with the code (see the AUTHORS 
53 file). Also, thanks to those who faithfully help me test each new version.