diff rogue4/INSTALL.txt @ 31:9223b6d7a243

Added INSTALL.txt files
author elwin
date Sat, 13 Feb 2010 16:25:29 +0000
parents
children a31b2cb545c5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/rogue4/INSTALL.txt	Sat Feb 13 16:25:29 2010 +0000
@@ -0,0 +1,41 @@
+		       Roguelike Gallery (rlgallery.org)
+
+This is the source code for the Roguelike Gallery's version of Rogue V4.
+
+History
+Rogue 4.2 was released by Michael Toy, Ken Arnold, and Glenn Wichman, probably 
+early in 1982.  Several updates were issued, and the major version number was 
+incremented, so the last of the series was Rogue 5.2, released April 1982.
+
+The Roguelike Restoration Project (rogue.rogueforge.net) updated the game to 
+work on modern systems.
+
+The Roguelike Gallery's version has been slightly modified for compatibility 
+with dgamelaunch and security for multiple players.
+
+Installing
+First, configure for your system by editing the makefile.  The CFLAGS and SF 
+lines contain four defines (-DSOMETHING=filename).  (This is an awkward 
+configuration method which I plan to change soon.)  The defaults are for 
+a system-wide installation, which will require setgid on the binary.  For a 
+single-user installation, remove SAVEDIR and set the other three to locations 
+somewhere in your home directory.  (That's probably the best thing to do on 
+Windows, too.)
+
+Once that's finished, compile by running make.  On Windows, I haven't tested 
+the Visual Studio project files; the game should build, but the scorefile 
+might not work. 
+
+If you want multi-user play, install the rogue binary with setgid games.  You 
+will need to make sure that SAVEDIR exists and that savefiles, SCOREFILE, 
+LOCKFILE and LOGFILE can be created and written by the games group (assuming 
+you want those features.)  For a single user, you shouldn't need to install.
+
+Playing
+For more details, see rogue.6 (the man page) and rogue.me (Michael Toy's "Guide 
+to the Dungeons of Doom").  Troff format is a little outdated, but you should 
+be able to discover something with a text editor.  I plan to add versions in 
+more common formats soon.
+
+Contact
+rlgallery.org admin: John "Elwin" Edwards <elwin@sdf.lonestar.org>