Return to README.txt CVS log

Up to [contributed] / early-roguelike

Annotation of early-roguelike/README.txt, Revision 1.1.1.2

1.1       rubenllo    1: --- Early Roguelike Collection
                      2:
                      3: This is the source for the Roguelike Gallery's versions of Rogue and other
                      4: early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.
                      5:
1.1.1.2 ! rubenllo    6: The code was obtained from the Roguelike Restoration Project (Web site formerly
        !             7: at rogue.rogueforge.net).  Modifications have been made for compatibility with
        !             8: the dgamelaunch play system, and compliance with modern C compiler standards.
        !             9: Some bugs have also been fixed, and the build process slightly improved.  The
1.1       rubenllo   10: essential flavor of a codebase half as old as stored-program computing
                     11: machinery remains unchanged.  The gameplay and the user interface will be kept
                     12: true to the originals.
                     13:
                     14: This collection does not contain the versions of Rogue commercially released by
                     15: Epyx for DOS, the Mac, and other graphical platforms of the 1980's.  Nor does
                     16: it include Rogue Clone, a reimplementation sometimes found in BSD or Linux
                     17: distributions.
                     18:
1.1.1.2 ! rubenllo   19: UltraRogue has recently been added to the collection.  It is not quite in a
        !            20: finished state.  There are known bugs that could cause crashes.
1.1       rubenllo   21:
                     22: --- Installation
                     23:
                     24: To install on Unix (including OS X):
                     25:
                     26: If you checked out the source from Mercurial, run 'autoreconf' first.
                     27:
                     28: Build by running './configure' and then 'make' within each game's subdirectory.
                     29: If you only want to play the games from one user account, 'configure' won't
                     30: need any options.  The games will keep the high score lists in whatever
                     31: directory you run them from.
                     32:
                     33: For a multi-user installation, you will need to set the '--enable-setgid',
                     34: '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options.  Run
                     35: 'make install' with root privileges after building.
                     36:
                     37: There are other possible options; run './configure --help' for a full list.
                     38:
                     39: To install on Windows:
                     40:
1.1.1.2 ! rubenllo   41: Warning: Windows installation was last tested on Windows 8.1.
        !            42:
        !            43: Visual Studio solution and project files are included.  They were created with
        !            44: Visual Studio 2015.
1.1       rubenllo   45:
                     46: You will need pdcurses before you can build.  Create a folder called 'pdcurses'
                     47: in this folder and copy into it curses.h, term.h, and pdcurses.lib from the
                     48: pdcurses distribution.
                     49:
                     50: You can also build on Windows using MinGW.  Make sure pdcurses is installed.
                     51: You will have to go into the '/lib' folder and copy 'libpdcurses.a' to
1.1.1.2 ! rubenllo   52: 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'.
1.1       rubenllo   53:
                     54: It is recommended to run 'configure' with the '--disable-logfile' option, and
                     55: 'make' with the 'LDFLAGS=-static' option.
                     56:
1.1.1.2 ! rubenllo   57: UltraRogue is not yet integrated with the Visual Studio solution file.
1.1       rubenllo   58:
                     59: See the individual games' subdirectories for further documentation.  Some of
                     60: the manpages may be outdated, but the guides to playing should be accurate.
                     61:
                     62: The games can be played via SSH or the Web at rlgallery.org.
                     63:
                     64: --- Licensing
                     65:
                     66: Each game is covered by its own license, usually some variant of the 4-clause
                     67: BSD license.  See the LICENSE.TXT files in the individual subdirectories for
                     68: more details.
                     69:
                     70: All modifications made by the Roguelike Gallery are available under the same
                     71: terms as the game to which they were made.
                     72:
                     73: --- Bugs
                     74:
1.1.1.2 ! rubenllo   75: The original authors claimed that the list of bugs was "probably infinite".
        !            76: There was previously a bug tracker on Bitbucket, but Bitbucket seems to have
        !            77: been taken over by leprechauns, so bugs cannot be reported there.  There will
        !            78: be an announcement when a new bug tracker is set up.