Mercurial > hg > early-roguelike

annotate README.txt @ 209:4438569c1b02

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge the MSVC branch.
author John "Elwin" Edwards
date Fri, 27 Nov 2015 08:59:24 -0500
parents 4146e2a06bc1
children d0f652010675
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
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
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
13 To install on Unix (including OS X):
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
14
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
15 If you checked out the source from Mercurial, run 'autoreconf' first.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
16
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
17 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
18 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
19 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
20
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
21 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
22 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
23 'make install' after building.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
24
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
25 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
26
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
27 To install on Windows:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
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
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
35
122
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
36 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
37 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
38 '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
39 fixed soon.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
40
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
41 It is recommended to run 'configure' with the '--disable-logfile' option, and
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
42 'make' with the 'LDFLAGS=-static' option.
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
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
65f3da34578a rogue4, arogue5: improve portability.
John "Elwin" Edwards
parents: 106
diff changeset
46
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
47 See the individual games' subdirectories for further documentation. Some of
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
48 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
49
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
50 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
51
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
52 Bugs:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
53
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
54 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
55 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
56 https://bitbucket.org/ElwinR/rl.