Mercurial > hg > early-roguelike
annotate README.txt @ 223:0e99eade579c
Generate text documentation from the troff source files.
This is done by make, in the 'docs' target, which is now part of the
normal build process.
Unfortunately, not all the games include troff sources. Getting decent
HTML output from groff is still a difficult process which will not be
attempted at this time. There are a few bugs in the 'install' and
'uninstall' rules.
Not to mention that the documentation is sometimes inaccurate.
author | John "Elwin" Edwards |
---|---|
date | Sun, 21 Feb 2016 20:47:12 -0500 |
parents | 4146e2a06bc1 |
children | d0f652010675 |
rev | line source |
---|---|
80 | 1 This is the source for the Roguelike Gallery's versions of Rogue and other |
2 early roguelike games. | |
3 | |
4 The code was obtained from the Roguelike Restoration Project | |
5 (rogue.rogueforge.net). Modifications have been made mainly for compatibility | |
6 with the dgamelaunch online play system. Some bugs have also been fixed, and | |
7 the build process slightly improved. The essential flavor of a codebase half | |
8 as old as stored-program computing machinery remains unchanged. | |
9 | |
154
4ef27dfe0492
Mention arogue7 and xrogue in the README.
John "Elwin" Edwards
parents:
123
diff
changeset
|
10 Advanced Rogue 7 and XRogue were recently added and are still in an |
4ef27dfe0492
Mention arogue7 and xrogue in the README.
John "Elwin" Edwards
parents:
123
diff
changeset
|
11 experimental state. |
4ef27dfe0492
Mention arogue7 and xrogue in the README.
John "Elwin" Edwards
parents:
123
diff
changeset
|
12 |
122 | 13 To install on Unix (including OS X): |
106 | 14 |
15 If you checked out the source from Mercurial, run 'autoreconf' first. | |
16 | |
17 Build by running './configure' and then 'make'. If you just want to play the | |
18 game from your own user account, 'configure' won't need any options. The | |
19 games will keep the high score lists in whatever directory you run them from. | |
20 | |
21 For a multi-user installation, you will need to set the '--enable-setgid', | |
22 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run | |
23 'make install' after building. | |
24 | |
25 There are other possible options; run './configure --help' for a full list. | |
26 | |
27 To install on Windows: | |
28 | |
208
4146e2a06bc1
Update the Visual Studio project files.
John "Elwin" Edwards
parents:
154
diff
changeset
|
29 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
|
30 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
|
31 |
4146e2a06bc1
Update the Visual Studio project files.
John "Elwin" Edwards
parents:
154
diff
changeset
|
32 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
|
33 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
|
34 pdcurses distribution. |
106 | 35 |
122 | 36 You can also build on Windows using MinGW. Make sure pdcurses is installed. |
37 You will have to go into the '/lib' folder and copy 'libpdcurses.a' to | |
38 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'; this should get | |
39 fixed soon. | |
40 | |
41 It is recommended to run 'configure' with the '--disable-logfile' option, and | |
42 'make' with the 'LDFLAGS=-static' option. | |
43 | |
208
4146e2a06bc1
Update the Visual Studio project files.
John "Elwin" Edwards
parents:
154
diff
changeset
|
44 Note that Super-Rogue has problems with restoring saved games on Windows, |
4146e2a06bc1
Update the Visual Studio project files.
John "Elwin" Edwards
parents:
154
diff
changeset
|
45 whichever build system is used. |
122 | 46 |
106 | 47 See the individual games' subdirectories for further documentation. Some of |
48 the manpages may be outdated, but the guides to playing should be accurate. | |
80 | 49 |
50 The games can be played via SSH or the Web at rlgallery.org. | |
106 | 51 |
52 Bugs: | |
53 | |
54 The original authors claimed that the list of bugs was "probably infinite". If | |
55 you encounter one of these, please report it on the bug tracker at | |
56 https://bitbucket.org/ElwinR/rl. |