About this game
===============

Enigma is a tribute to and a re-implementation of one of the most
original and intriguing computer games of the 1990's: Oxyd.  Your
objective is easily explained: find and uncover all pairs of identical
Oxyd stones in each landscape.  Sounds simple?  It would be, if it
weren't for hidden traps, vast mazes, insurmountable obstacles and
innumerable puzzles blocking your direct way to the Oxyd stones...

Enigma is not nearly finished and help is always appreciated.  If you
enjoy programming, painting, recording sound effects, or designing
levels, you can always join our developers' mailing list at

    http://mail.nongnu.org/mailman/listinfo/enigma-devel

You do not need to join to send emails to the list, simply mail to

   enigma-devel@nongnu.org

The official Enigma homepage can be found at

    http://www.nongnu.org/enigma/

If you have any questions, suggestions, or contributions, feel free to
send email to the mailing list or to my personal address below.  Have
fun!

    Daniel Heck <dheck@ix.urz.uni-heidelberg.de>


Playing
=======

The idea behind Enigma is simple: In most levels your job is to find
pairs of "Oxyd" stones (you will recognize them when you see them)
with matching colors.  Just play the first levels in the "Oxyd & Co"
group and you will get the idea.  In some other levels, called
"meditation landscapes" you have a somewhat different job: You control
a couple of small white marbles simultaneously and have to put each of
them into a pit on the floor.

There are many different game objects, all of them behaving in unique
ways.  Don't be intimidated: experimentation and exploration is part
of the game, 


Here is a list of controls during the game:

    Left mouse button	Apply first item in inventory.
    Right mouse	button	Rotate inventory items.
    
    ESC			Display game menu
    F1                  Display help screen
    F3			Restart the current level
    Left arrow          Decrease mouse speed
    Right arrow         Increase mouse speed
    Alt-Return		Toggle between fullscreen and windowed display
    Alt-X               Return to the level menu immediately

You can see this list by entering the online help (F1) during the
game, so you need not memorize it now.


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

Installation on Windows and MacOS X is straightforward: Simply
download the appropriate .exe or .dmg file and start it with a double
click.

Things get a little more complicated for other operating systems,
please refer to Enigma's download page

       http://www.nongnu.org/enigma/download.html
       
for up-to-date information.  If you are running some kind Unix system,
you have always the option of compiling Enigma yourself; see the next
section for more information.

There may or may not be binaries for your Linux distribution of
choice, and they may or may not work on your computer.  This is not
our fault: packaging a Linux version that works everywhere is almost
impossible--please ask you vendor to make their distribution more
compatible if this bugs you.


Using Oxyd's original sounds with Enigma
----------------------------------------

Enigma can use Oxyd's sound effects if you ask politely.  Every
version of Oxyd contains a data file that contains the levels,
graphics, and sound effects:

     Per.Oxyd 		peroxyd.dat
     Oxyd 1		oxyd1ibm.dat
     Oxyd extra		oxydex.dat
     Oxyd magnum	oxydmibm.dat

You must copy one of these to Enigma's "data" directory.  From now on,
Enigma will use Oxyd's original sound effects.

Per.Oxyd and Oxyd 1 are dongleware (i.e., some kind of shareware), so
you can download them freely from the Internet (search for "oxyd
abandonware"; Google is your friend).  Oxyd extra and magnum are not
shareware, so you may only use them if you have a legal copy.

Please do not ask us to send you copies of any Oxyd version, we won't.
Oxyd may be Abandonware, but it's still copyrighted, and we respect
that.


Compiling Enigma
================

If you want to compile Enigma from source, you must have the following
programs and libraries installed

    * A C++ compiler
    
      GNU C++ 2.95 and 3.2 are officially supported, older versions won't
      work.  If you use another C++ compiler, your mileage may vary.
      Intel C++ used to work, but we haven't tested it in a long time.
      
    * SDL >= 1.2 (www.libsdl.org)
    * SDL_mixer >= 1.2.0 (http://www.libsdl.org/projects/SDL_mixer)
    * SDL_image >= 1.2.0 (http://www.libsdl.org/projects/SDL_image)
    
      These should already come with most reasonably up-to-date Linux
      distributions.  If you don't have them on your system, please
      download and install them before trying to build Enigma.

Installation should then be as easy as entering

    ./configure && make && make install

in the enigma directory.


Known problems
--------------

* Compilation fails on HPPA: This happens when you compile Enigma
  without specifying the '-ffunction-sections' option. Configure as
  follows:

        CXXFLAGS='-ffunction-sections' ./configure


Copying
=======

This game is free software.  You may copy and modify it under the
terms of the GNU General Public License, Version 2 or, at your option,
any later version.  For details, please refer to the accompanying 
COPYING.GPL file.

To my best knowledge the included sound effects are either in the
public domain or freely distributable.  I wasn't able to pin down the
exact origin of each sound file -- the copyrights of which I am aware
are collected in sound/README.  Please refer to this list before using
the samples in your productions.
