comparison README.txt @ 302:fa70bba6bb3f rel2021.03

Update the README.
author John "Elwin" Edwards
date Thu, 18 Mar 2021 20:53:49 -0400
parents 7fcb2f9f57e6
children
comparison
equal deleted inserted replaced
301:acc3718f50ab 302:fa70bba6bb3f
1 --- Early Roguelike Collection 1 --- Early Roguelike Collection
2 2
3 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
4 early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue. 4 early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.
5 5
6 The code was obtained from the Roguelike Restoration Project (Web site at 6 The code was obtained from the Roguelike Restoration Project (Web site formerly
7 rogue.rogueforge.net). Modifications have been made for compatibility with the 7 at rogue.rogueforge.net). Modifications have been made for compatibility with
8 dgamelaunch play system, and compliance with modern C compiler standards. Some 8 the dgamelaunch play system, and compliance with modern C compiler standards.
9 bugs have also been fixed, and the build process slightly improved. The 9 Some bugs have also been fixed, and the build process slightly improved. The
10 essential flavor of a codebase half as old as stored-program computing 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 11 machinery remains unchanged. The gameplay and the user interface will be kept
12 true to the originals. 12 true to the originals.
13 13
14 This collection does not contain the versions of Rogue commercially released by 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 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 16 it include Rogue Clone, a reimplementation sometimes found in BSD or Linux
17 distributions. 17 distributions.
18 18
19 UltraRogue has recently been added to the collection. It is still in an 19 UltraRogue has recently been added to the collection. It is not quite in a
20 experimental state, with several known bugs. 20 finished state. There are known bugs that could cause crashes.
21 21
22 --- Installation 22 --- Installation
23 23
24 To install on Unix (including OS X): 24 To install on Unix (including OS X):
25 25
36 36
37 There are other possible options; run './configure --help' for a full list. 37 There are other possible options; run './configure --help' for a full list.
38 38
39 To install on Windows: 39 To install on Windows:
40 40
41 Visual Studio solution and project files are included. They are still being 41 Warning: Windows installation was last tested on Windows 8.1.
42 tested but should work with Visual Studio 2015 on Windows 8.1. 42
43 Visual Studio solution and project files are included. They were created with
44 Visual Studio 2015.
43 45
44 You will need pdcurses before you can build. Create a folder called 'pdcurses' 46 You will need pdcurses before you can build. Create a folder called 'pdcurses'
45 in this folder and copy into it curses.h, term.h, and pdcurses.lib from the 47 in this folder and copy into it curses.h, term.h, and pdcurses.lib from the
46 pdcurses distribution. 48 pdcurses distribution.
47 49
48 You can also build on Windows using MinGW. Make sure pdcurses is installed. 50 You can also build on Windows using MinGW. Make sure pdcurses is installed.
49 You will have to go into the '/lib' folder and copy 'libpdcurses.a' to 51 You will have to go into the '/lib' folder and copy 'libpdcurses.a' to
50 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'; this should get 52 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'.
51 fixed soon.
52 53
53 It is recommended to run 'configure' with the '--disable-logfile' option, and 54 It is recommended to run 'configure' with the '--disable-logfile' option, and
54 'make' with the 'LDFLAGS=-static' option. 55 'make' with the 'LDFLAGS=-static' option.
55 56
56 UltraRogue is not yet integrated with Autoconf or the Visual Studio solution 57 UltraRogue is not yet integrated with the Visual Studio solution file.
57 file.
58 58
59 See the individual games' subdirectories for further documentation. Some of 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. 60 the manpages may be outdated, but the guides to playing should be accurate.
61 61
62 The games can be played via SSH or the Web at rlgallery.org. 62 The games can be played via SSH or the Web at rlgallery.org.
70 All modifications made by the Roguelike Gallery are available under the same 70 All modifications made by the Roguelike Gallery are available under the same
71 terms as the game to which they were made. 71 terms as the game to which they were made.
72 72
73 --- Bugs 73 --- Bugs
74 74
75 The original authors claimed that the list of bugs was "probably infinite". If 75 The original authors claimed that the list of bugs was "probably infinite".
76 you encounter one of these, please report it on the bug tracker at 76 There was previously a bug tracker on Bitbucket, but Bitbucket seems to have
77 https://bitbucket.org/ElwinR/rl. 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.