
Curse of Frogger
================

Running the Game
----------------

This directory contains source for a simple curses-based video game based
on the classic "Frogger" arcade game of yesteryear.

To run the game in the same window that you used to launch the program:
use the "frogger.sh" script as follows:

    $ ./frogger.sh

To run the game in a separate xterm window, use the following instead:

    $ ./frogger.sh -w

You may need to edit this script to tell it where Portable.NET is located
if something went wrong during the build.  The environment variables to
change are "ILRUN" and "CORLIB_PATH".

Playing the Game
----------------

The object of the game is to get your frog from one side of a toxic waste
infected river to the other by jumping from log to log.  Sounds simple?
Not really:

    * If you miss a log, you drown in toxic waste and die.
    * If a log that you are sitting on scrolls off the edge of the
      screen, you fall over a waterfall and die.
    * If you have even one toe over the edge of the log and dangling
      in the water, you die from toxic exposure.
    * If the 10 second timeout expires, you die from accumulated toxic fumes.

A frog's life is never easy.  Once you reach the other side of the river,
you need to cross the next river, and so on until you get bored.

The following keys may be used to control the movement of your frog:

    Up arrow or 'j'

        Move the frog up the screen.

    Down arrow or 'k'

        Move the frog down the screen.

    Left arrow or 'h'

        Move the frog left.

    Right arrow or 'l'

        Move the frog right.

    's'

        Toggle sound on and off, assuming your system can produce a
        curses "beep".  The sound is on by default.

        Note: some systems are configured to flash the window when
        a beep is requested.  So, if you see an annoying flash every
        time you move your frog, instead of hearing a beep, just hit
        the 's' key and the flash should go away.

    Esc or 'q'

        Quit the game.

The game isn't terribly challenging at present.  Patches are welcome to make
the game harder, add extra levels, scoring, etc.

Portability
-----------

This program will run on Microsoft's CLR if you have Cygwin installed to
provide the curses library.  You will need to copy the following files
to a common directory:

    help/.libs/libcsharpcurses-0-0-1.dll
    src/Curses.dll
    frogger/frogger.exe

Then run the "frogger.exe" executable from the Cygwin command-line.

It isn't necessary to copy the files if you are using Portable.NET,
because the "frogger.sh" script takes care of the search path issues.
