early-roguelike/README.txt

--- Early Roguelike Collection

This is the source for the Roguelike Gallery's versions of Rogue and other
early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.

The code was obtained from the Roguelike Restoration Project (Web site at
rogue.rogueforge.net).  Modifications have been made for compatibility with the
dgamelaunch play system, and compliance with modern C compiler standards.  Some
bugs have also been fixed, and the build process slightly improved.  The
essential flavor of a codebase half as old as stored-program computing
machinery remains unchanged.  The gameplay and the user interface will be kept
true to the originals.

This collection does not contain the versions of Rogue commercially released by
Epyx for DOS, the Mac, and other graphical platforms of the 1980's.  Nor does
it include Rogue Clone, a reimplementation sometimes found in BSD or Linux 
distributions.

--- Installation

To install on Unix (including OS X):

If you checked out the source from Mercurial, run 'autoreconf' first.

Build by running './configure' and then 'make' within each game's subdirectory.
If you only want to play the games from one user account, 'configure' won't
need any options.  The games will keep the high score lists in whatever
directory you run them from.

For a multi-user installation, you will need to set the '--enable-setgid',
'--enable-savedir', '--enable-scorefile', and '--enable-logfile' options.  Run
'make install' with root privileges after building.

There are other possible options; run './configure --help' for a full list.

To install on Windows:

Visual Studio solution and project files are included.  They are still being
tested but should work with Visual Studio 2015 on Windows 8.1.

You will need pdcurses before you can build.  Create a folder called 'pdcurses'
in this folder and copy into it curses.h, term.h, and pdcurses.lib from the
pdcurses distribution.

You can also build on Windows using MinGW.  Make sure pdcurses is installed.
You will have to go into the '/lib' folder and copy 'libpdcurses.a' to
'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'; this should get
fixed soon.

It is recommended to run 'configure' with the '--disable-logfile' option, and
'make' with the 'LDFLAGS=-static' option.

See the individual games' subdirectories for further documentation.  Some of 
the manpages may be outdated, but the guides to playing should be accurate.

The games can be played via SSH or the Web at rlgallery.org.

--- Licensing

Each game is covered by its own license, usually some variant of the 4-clause
BSD license.  See the LICENSE.TXT files in the individual subdirectories for
more details.

All modifications made by the Roguelike Gallery are available under the same
terms as the game to which they were made.

--- Bugs

The original authors claimed that the list of bugs was "probably infinite".  If 
you encounter one of these, please report it on the bug tracker at 
https://bitbucket.org/ElwinR/rl.