=== How to play
Up to four players (red, green, blue, and yellow) are trying to escape with as
many of their units as possible from the island of Atlantis, which is sinking
into the sea, onto safer neighbouring islands.

Ships and friendly dolphins can aid the units' escape. Sharks, octopi, and sea
monsters impede them. The board of the game is a hexagonial one.

When atlantis is started, ships can be placed around the island by clicking.
(Right-click to remove ships. Each hexagon can have only one ship.) Once enough
ships have been added, press 'n' to go to the next stage: placing units.

Units can be placed anywhere on the island of Atlantis, though only three can
be placed on each land hexagon (so with four players some haggling may be
necessary). The yellow land is closest to the ocean and thus most convenient
for escape, but also the most dangerous. Click to place units, and right-click
to remove them. Each player can have up to twelve units. Press 't' to switch
between players.

Now press 'n' again to go onto the next mode. This is the beginning of the
first turn. Units, ships, and (occupied) dolphins can be moved, for a total of
three moves. (There won't be any animals on the board yet, but be patient --
there will be.) Note that moving most units takes only one move, but a lone
unit swimming through the water takes all three to move one hexagon.

Dolphins can carry one rider (but are risky, as mentioned below). Ships can
carry up to three units, and are controlled by whichever player (or players)
have the majority of units on board.

After three moves (or after pressing 'n' to forfiet all remaining moves), the
die are rolled, and the player can move the animal that is shown on the die. A
"D" means "dive"; the animal can move as far as the player likes, as long as it
doesn't surface on the same hexagon as another swimmer, ship, or occupied
dolphin.

When dangerous animals occupy the same hexagon as ships and such, bad things
can happen to your units. Sharks eat swimmers and dolphin riders, octopi sink
occupied ships, and sea monsters eat everything that isn't an animal. Beware.

After this stage of the turn (or after 'n' is pressed), part of the island can
be sunk. Note that the lowest (yellow) portions of the island have to all sink
before the next lowest (green) can begin to. Any units on the hexagon that is
sunk will end up in the water, haplessly, with whatever might appear. (It
probably won't be good.)

What might appear? Any of the animals mentioned, or perhaps a ship; or perhaps
a whirlpool, which will suck in all of its surroundings, including animals,
swimmers, and ships. (Don't sink island hexagons near your units if possible.)

After the island hexagon is sunk, the turn begins again.

Even though it isn't implemented, the winner is the one with the most units on
safe islands when any player runs out of units to move (i.e., has all of their
units eaten or in safety).

No, units sitting in a ship outside a safe haven do not count as "safe". :)


=== Other keys
When more than one type of unit occupies a hexagon, these keys may be useful:
- pressing 'u' selects a swimmer;
- pressing 's' selects a ship;
- and pressing 'd' selects a dolphin.

Pressing CTRL selects an individual unit that is occupying a ship or dolphin.

Pressing SHIFT forces the move to go ahead, even though it is likely a
dangerous one. (Useful for suiciding units.)

Oh, and ALT-ENTER toggles fullscreen mode.

For debugging purposes only:
- 'm' scrolls through all of the possible modes (like 'n', but lets you go
  back and add more units to the island . . .);
- CTRL-H, -D, -S, -O, -R add a ship, dolphin, shark, octopus, or sea monster,
  respectively, anywhere in the sea;
- and 't' actually works at any time to scroll through turns.

=== Programming details
Atlantis is written in C++. It is built on top of another C++ library by the
same author called mundus. mundus is supposed to support multiple different
libraries, but at the moment only supports the SDL. Nevertheless, the SDL is
very portable, and so atlantis can be run on many different platforms.

Atlantis and mundus both use git for version control.

At the moment, atlantis and mundus can be downloaded from
    http://dwks.theprogrammingsite.com/myprogs/atlantis.htm

=== History
Atlantis is based on a board game by Waddington Sanders called "Escape from
Atlantis", copyright 1987. I enjoyed the game so much that I wrote an
electronic version. Hopefully the publisher doesn't mind me taking the idea
into the digital world.

This is my third attempt at writing an Atlantis game (though only the second
serious one).