Head Over Heels (10/12/2003)
===============

Linux port by Joseph P. Morris (jpm@it-he.org)

This is the Linux version of the Retrospec remake of Head Over Heels,
a very cool game for the ZX Spectrum in 1987, in which two dog-things
attempt to overthrow a repressive empire.

The game was originally written by the legendary Jon Ritman and Bernie
Drummond.  The remake was done by Tomaz Kac, Graham Goring and a host
of others.

Full documentation is in the 'docs' directory.  Once the game is fully
installed it will be put in '/usr/local/share/doc/HoH'.

The official website is at http://retrospec.sgn.net


Installation
=============

To install the game, unpack the archive somewhere (you should have
already done that if you can read this message!) and run './install.sh'.
It's not very pretty, but it does work.

The installer will tell you what it's about to do.  By default it will
put the game in '/usr/local/share/games/HoH' and create a script to
run the game, which will be '/usr/local/bin/hoh'.

After that, you can run the game by typing 'hoh' on the command line.
If you're using KDE, you can easily create a shortcut to the 'hoh'
program much like Windows, but the installer won't do this for you (yet).

The default location will require you to be logged in as root for it
to be installed.  If you want to install it somewhere else, like in
your home directory, edit the file 'install.sh', and change the
location where the files will go.

The installer will also create a program called 'hoh-uninstall.sh' which
will remove the Head-Over-Heels program from your machine.


Notes and Errata
================

1. The game has been built without SVGALIB support.  FBcon may work but
   I haven't been able to test it.  The following problems were noted with
   SVGALIB and may also apply to FBcon:

   The game ran very slowly in SVGALIB when complex shadows were
   enabled.  You can fix this by setting the Shadows mode to 'Simple'
   or 'Medium' in the menu.  The cause of this is not known.
   
   The game also crashed when switching between Windowed and Fullscreen
   mode in SVGALIB, again the cause is unknown and could not be debugged.
   You may need to force the game to run fullscreen, see below.

2. To force the game to run fullscreen, run it with 'hoh -r1',
   Conversely, if you want the game to start in a window (in X) use
   'hoh -r0'.

3. When running in a window, red and blue may be switched over.
   Use 'hoh -bgr' to fix this.  You can combine it with -r0 and -r1

4. Savegames and configuration are written to '.hoh' in your home
   directory.

5. For best performance, the game can use the DGA extensions under
   Xwindows.  Unfortunately this seems to need the game to be run as
   the superuser (root) which is a potential security hazard.

   Triple-buffering only works in DGA mode.

6. The game will try to use DGA mode by default; if you are logged
   in as a regular user, you may see a warning appear on the console
   about setting the video mode.  Just ignore it.

