README

   1 About Enigma
   2 ============
   3
   4 Enigma is a unique puzzle game, with influences from almost every game
   5 genre.  Your objective is easily explained: you control a small black
   6 marble with your mouse and have to find and uncover all pairs of
   7 identical Oxyd stones in each landscape.  Simple? Yes.  Easy? It would
   8 be, if it weren't for hidden traps, vast mazes, insurmountable
   9 obstacles and innumerable puzzles blocking your direct way to the Oxyd
  10 stones... If you like puzzle games and have a steady hand, Enigma's
  11 more than 1500 levels will probably keep you busy for hours on end.
  12
  13 Enigma is developed by a small group of volunteers, and help is always
  14 appreciated.  If you like Enigma and want to contribute to its future,
  15 you are welcome to join us on our development mailing list at
  16
  17     http://mail.nongnu.org/mailman/listinfo/enigma-devel
  18
  19 or simply send email to
  20
  21     enigma-devel@nongnu.org
  22
  23 Every kind of contribution is welcome, whether it is programming,
  24 documentation, graphics, sound effects, or simply good advice.
  25
  26
  27 The official Enigma homepage can be found at
  28
  29     http://www.nongnu.org/enigma/
  30
  31 If you have any questions, suggestions, or contributions, feel free to
  32 send email to the mailing list.  Have fun!
  33
  34     The Enigma Team
  35
  36
  37 Playing Enigma
  38 ==============
  39
  40 Please refer to the user manual for instructions on how to play Enigma,
  41 or simply start with the tutorial levels included with the game.
  42
  43
  44 Installation
  45 ============
  46
  47 Installation on Windows and Mac OS X is straightforward: Simply download
  48 the appropriate .exe or .dmg file and start it with a double click.
  49
  50 Things get a little more complicated for other operating systems,
  51 please refer to Enigma's download page
  52
  53        http://www.nongnu.org/enigma/download.html
  54
  55 for up-to-date information.  If you are running some kind of Unix system,
  56 you have always the option of compiling Enigma yourself; this is
  57 explained in the next section.
  58
  59 There may or may not be binaries for the Linux distribution of your choice,
  60 and they may or may not work on your computer.  This is not our fault:
  61 packaging a Linux version that works everywhere is almost impossible,
  62 thanks to countless subtle and not-so-subtle differences between each
  63 and every Linux distribution.  Please complain to your vendor if this
  64 bugs you.
  65
  66
  67 Compiling Enigma
  68 ================
  69
  70 This section briefly describes how to compile Enigma on a Unix
  71 machine.  If you want to build Enigma on Windows or Mac OS X, please
  72 see the documentation in `doc/README.mingw32' and `doc/README.macosx',
  73 respectively.
  74
  75 For a list of libraries and programs that must be installed to compile
  76 Enigma, please refer to `doc/REQUIREMENTS' for a complete list.
  77
  78 Once you have everything installed, building Enigma is as easy as typing
  79
  80     ./autogen.sh && ./configure && make && make install
  81
  82 in the enigma directory.
  83
  84
  85 Copying
  86 =======
  87
  88 Enigma is free software.  You may copy and modify it under the terms
  89 of the GNU General Public License, Version 2 or, at your option, any
  90 later version.  For details, please refer to the accompanying
  91 COPYING file.
  92
  93   Please refer to the ACKNOWLEDGEMENTS file that comes with Enigma for
  94 copyright information and licensing terms of external dependencies and
  95 contributions to this project.
  96
  97   To my best of our knowledge the included sound effects are either in the
  98 public domain or freely distributable.  We weren't able to pin down the
  99 exact origin of each sound file -- the copyrights of which we are aware
 100 are collected in soundsets/enigma/README.  Please refer to this list
 101 before using the samples in your productions.
 102