Read Me

Hexagonal Minesweeper
=====================

Author	: grayswander@users.sf.net
License	: GPL v2 (see LICENSE)
Status	: stable

Dependencies
------------
1) python interpreter (www.python.org)
2) pygame python module (www.pygame.org)

Installation
------------
1) Make sure you have mentioned dependencies. If not - install them.
   On Linux and most other Unixes you would have python installed almost for sure.
   Both Python interpreter and pygame module are free software.
2) Untar (unpack) downloaded tarball (archive) wherever it suites you.
   The archive already contents directory (folder) named "hexamine"

Configuration
-------------
Hexamine searches for configuration file in this order:
1) ~/.hexamine (in user home directory)
2) /etc/hexamine.conf
3) hexamine.conf (in game directory)

The configuration file consists of [global] section, where you define skin to use and profile
and [<profile>] sections.
You can add/remove/edit profiles to adjust game experience.


Running
-------
Linux/Unixes:
Execute
	$ /game/directory//hexamine
or
	$ cd /game/directory/
	$ python ./hexamine.py

Windows:
Enter game directory and doubleclick on hexamine.py
For those, who do not have extentions shown, there should be nice green snake (python) on file icon.
For advanced users, you can choose pythonw.exe in "Open With..." to get rid of command prompt window.

Playing
-------
You have a field of hexagonal cells. Each cell can contain a mine of power 1-3 or be empty. The aim is to reveal all the empty cells on the field. Very much like famous Minesweeper.
You can flag the cell with numbers 1-3 by right-clicking on it (repeat to increase the number), if you think there is a mine.
You can open a cell by left-clicking on it. If there is a mine - you loose. Otherwise the cell opens, revealing two numbers in form "<ct>/<ft>", where:
	<ct> - close threat - sum of mine powers in cells, ajacent to cell in question(circle with radius 1 cell).
	<ft> - far threat   - sum of mine powers minus one(for each mine: 1->0, 2->1, 3->2) in cells, which are on circle with radius 2 cells.
	Close and far threats are totally independent. Any mine can impose either far, close or no threat for any given  cell, but not both!
Close threat for cell is marked while mouse cursor is over it.
When you open a cell with close threat 0, it automatically reveals all the ajacent cells.
If you fail, by opening mined field, the game shows all the mines.
If you win, by opening all empty cells, mined cells turn green.

Thanks
------
1) The general game idea is based on famous Minesweeper
2) The idea of mines with different power is taken from MegaMiner proprietary game by Astatix Software
3) All the graphics code is copied almost as-is from HexagonExample by John Eriksson (http://arainyday.se/projects/python/HexagonExample/)