Mercurial > hg > early-roguelike

comparison README.txt @ 248:182e26224f92 rel2016.06

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README.txt: additions and clarifications.
author John "Elwin" Edwards
date Sun, 29 May 2016 17:05:38 -0400
parents d0f652010675
children 7fcb2f9f57e6
comparison
equal deleted inserted replaced
247:23d2e2bf812f 248:182e26224f92
1 --- Early Roguelike Collection
2
1 This is the source for the Roguelike Gallery's versions of Rogue and other 3 This is the source for the Roguelike Gallery's versions of Rogue and other
2 early roguelike games. 4 early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.
3 5
4 The code was obtained from the Roguelike Restoration Project 6 The code was obtained from the Roguelike Restoration Project (Web site at
5 (rogue.rogueforge.net). Modifications have been made mainly for compatibility 7 rogue.rogueforge.net). Modifications have been made for compatibility with the
6 with the dgamelaunch online play system. Some bugs have also been fixed, and 8 dgamelaunch play system, and compliance with modern C compiler standards. Some
7 the build process slightly improved. The essential flavor of a codebase half 9 bugs have also been fixed, and the build process slightly improved. The
8 as old as stored-program computing machinery remains unchanged. 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
19 --- Installation
9 20
10 To install on Unix (including OS X): 21 To install on Unix (including OS X):
11 22
12 If you checked out the source from Mercurial, run 'autoreconf' first. 23 If you checked out the source from Mercurial, run 'autoreconf' first.
13 24
14 Build by running './configure' and then 'make'. If you just want to play the 25 Build by running './configure' and then 'make' within each game's subdirectory.
15 game from your own user account, 'configure' won't need any options. The 26 If you only want to play the games from one user account, 'configure' won't
16 games will keep the high score lists in whatever directory you run them from. 27 need any options. The games will keep the high score lists in whatever
28 directory you run them from.
17 29
18 For a multi-user installation, you will need to set the '--enable-setgid', 30 For a multi-user installation, you will need to set the '--enable-setgid',
19 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run 31 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run
20 'make install' after building. 32 'make install' with root privileges after building.
21 33
22 There are other possible options; run './configure --help' for a full list. 34 There are other possible options; run './configure --help' for a full list.
23 35
24 To install on Windows: 36 To install on Windows:
25 37
41 See the individual games' subdirectories for further documentation. Some of 53 See the individual games' subdirectories for further documentation. Some of
42 the manpages may be outdated, but the guides to playing should be accurate. 54 the manpages may be outdated, but the guides to playing should be accurate.
43 55
44 The games can be played via SSH or the Web at rlgallery.org. 56 The games can be played via SSH or the Web at rlgallery.org.
45 57
46 Bugs: 58 --- Licensing
59
60 Each game is covered by its own license, usually some variant of the 4-clause
61 BSD license. See the LICENSE.TXT files in the individual subdirectories for
62 more details.
63
64 All modifications made by the Roguelike Gallery are available under the same
65 terms as the game to which they were made.
66
67 --- Bugs
47 68
48 The original authors claimed that the list of bugs was "probably infinite". If 69 The original authors claimed that the list of bugs was "probably infinite". If
49 you encounter one of these, please report it on the bug tracker at 70 you encounter one of these, please report it on the bug tracker at
50 https://bitbucket.org/ElwinR/rl. 71 https://bitbucket.org/ElwinR/rl.