annotate README.txt @ 122:65f3da34578a

rogue4, arogue5: improve portability. Most changes merely prevent including header files that don't exist. All games now build and run on MinGW, though bugs remain.
author John "Elwin" Edwards
date Wed, 07 May 2014 14:08:38 -0700
parents c191a735f811
children 8dd4b06a9155
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
1 This is the source for the Roguelike Gallery's versions of Rogue and other
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
2 early roguelike games.
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
3
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
4 The code was obtained from the Roguelike Restoration Project
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
5 (rogue.rogueforge.net). Modifications have been made mainly for compatibility
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
6 with the dgamelaunch online play system. Some bugs have also been fixed, and
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
7 the build process slightly improved. The essential flavor of a codebase half
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
8 as old as stored-program computing machinery remains unchanged.
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
9
122
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
10 To install on Unix (including OS X):
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
11
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
12 If you checked out the source from Mercurial, run 'autoreconf' first.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
13
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
14 Build by running './configure' and then 'make'. If you just want to play the
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
15 game from your own user account, 'configure' won't need any options. The
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
16 games will keep the high score lists in whatever directory you run them from.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
17
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
18 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
19 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
20 'make install' after building.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
21
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
22 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
23
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
24 To install on Windows:
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 Use the included Visual Studio solution files. Warning: they have not been
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
27 tested recently.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
28
122
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
29 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
30 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
31 '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
32 fixed soon.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
33
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
34 It is recommended to run 'configure' with the '--disable-logfile' option, and
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
35 'make' with the 'LDFLAGS=-static' option.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
36
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
37 The games should all build with MinGW, but there are still bugs with arrow keys
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
38 and saving/restoring.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
39
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
40 See the individual games' subdirectories for further documentation. Some of
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
41 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
42
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
43 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
44
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
45 Bugs:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
46
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
47 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
48 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
49 https://bitbucket.org/ElwinR/rl.