Mercurial > hg > early-roguelike

annotate README.txt @ 294:fe6b7a1a6dfc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve the documentation build process. The choice between troff implementations is now made at configure time, rather than using shell logic in the Makefile to choose while building.
author John "Elwin" Edwards
date Sat, 30 Dec 2017 14:15:52 -0500
parents 7fcb2f9f57e6
children fa70bba6bb3f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
1 --- Early Roguelike Collection
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
2
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
3 This is the source for the Roguelike Gallery's versions of Rogue and other
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
4 early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
5
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
6 The code was obtained from the Roguelike Restoration Project (Web site at
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
7 rogue.rogueforge.net). Modifications have been made for compatibility with the
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
8 dgamelaunch play system, and compliance with modern C compiler standards. Some
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
9 bugs have also been fixed, and the build process slightly improved. The
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
10 essential flavor of a codebase half as old as stored-program computing
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
11 machinery remains unchanged. The gameplay and the user interface will be kept
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
12 true to the originals.
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
13
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
14 This collection does not contain the versions of Rogue commercially released by
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
15 Epyx for DOS, the Mac, and other graphical platforms of the 1980's. Nor does
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
16 it include Rogue Clone, a reimplementation sometimes found in BSD or Linux
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
17 distributions.
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
18
265
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
19 UltraRogue has recently been added to the collection. It is still in an
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
20 experimental state, with several known bugs.
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
21
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
22 --- Installation
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
23
122
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
24 To install on Unix (including OS X):
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
25
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
26 If you checked out the source from Mercurial, run 'autoreconf' first.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
27
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
28 Build by running './configure' and then 'make' within each game's subdirectory.
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
29 If you only want to play the games from one user account, 'configure' won't
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
30 need any options. The games will keep the high score lists in whatever
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
31 directory you run them from.
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
32
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
33 For a multi-user installation, you will need to set the '--enable-setgid',
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
34 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
35 'make install' with root privileges after building.
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
36
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
37 There are other possible options; run './configure --help' for a full list.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
38
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
39 To install on Windows:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
40
208
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
41 Visual Studio solution and project files are included. They are still being
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
42 tested but should work with Visual Studio 2015 on Windows 8.1.
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
43
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
44 You will need pdcurses before you can build. Create a folder called 'pdcurses'
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
45 in this folder and copy into it curses.h, term.h, and pdcurses.lib from the
4146e2a06bc1 Update the Visual Studio project files.
John "Elwin" Edwards
parents: 154
diff changeset
46 pdcurses distribution.
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
47
122
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
48 You can also build on Windows using MinGW. Make sure pdcurses is installed.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
49 You will have to go into the '/lib' folder and copy 'libpdcurses.a' to
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
50 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'; this should get
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
51 fixed soon.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
52
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
53 It is recommended to run 'configure' with the '--disable-logfile' option, and
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
54 'make' with the 'LDFLAGS=-static' option.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
55
265
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
56 UltraRogue is not yet integrated with Autoconf or the Visual Studio solution
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
57 file.
7fcb2f9f57e6 Mention UltraRogue in the top-level README.
John "Elwin" Edwards
parents: 248
diff changeset
58
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
59 See the individual games' subdirectories for further documentation. Some of
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
60 the manpages may be outdated, but the guides to playing should be accurate.
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
61
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
62 The games can be played via SSH or the Web at rlgallery.org.
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
63
248
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
64 --- Licensing
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
65
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
66 Each game is covered by its own license, usually some variant of the 4-clause
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
67 BSD license. See the LICENSE.TXT files in the individual subdirectories for
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
68 more details.
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
69
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
70 All modifications made by the Roguelike Gallery are available under the same
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
71 terms as the game to which they were made.
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
72
182e26224f92 README.txt: additions and clarifications.
John "Elwin" Edwards
parents: 241
diff changeset
73 --- Bugs
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
74
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
75 The original authors claimed that the list of bugs was "probably infinite". If
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
76 you encounter one of these, please report it on the bug tracker at
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
77 https://bitbucket.org/ElwinR/rl.