annotate rogue3/readme36.html @ 229:50b89f165a34

Use uniform return types for functions related to options. Functions for printing options now return void. Functions for setting options now return int. Argument types still vary, though converting all the option pointers to void* would be possible.
author John "Elwin" Edwards
date Sun, 06 Mar 2016 14:45:18 -0500
parents 38acf3eb27e6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
1 <html>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
2 <head>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
3 <title>ROGUE</title>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
4 </head>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
5 <body>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
6
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
7 <h1 align=center>ROGUE 3.6</h1>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
8
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
9 <hr>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
10
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
11 <h2>NAME</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
12 <blockquote>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
13 <p>rogue3 &minus; Exploring The Dungeons of Doom</p>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
14 </blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
15
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
16 <h2>SYNOPSIS</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
17 <blockquote>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
18 <p><b>rogue3</b> [ -s ] [ <i>save_file</i> ] [ -n <i>playername</i> ]</p>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
19 </blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
20
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
21 <h2>DESCRIPTION</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
22 <blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
23
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
24 <p align="justify"><u>Rogue</u> is a computer fantasy game with a new twist.
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
25 It is crt oriented and the object of the game is to survive the attacks of various
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
26 monsters and get a lot of gold, rather than the puzzle solving orientation
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
27 of most computer fantasy games.</p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
28
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
29 <p align="justify">To get started you really only need to know two commands.
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
30 The command ? will give you a list of the available commands and the command /
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
31 will identify the things you see on the screen.</p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
32
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
33 <p align="justify">To win the game (as opposed to merely playing to beat
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
34 other people's high scores) you must locate the Amulet of Yendor which is
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
35 somewhere below the 20th level of the dungeon and get it out. Nobody has
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
36 achieved this yet and if somebody does, they will probably go down in history
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
37 as a hero among heros.</p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
38
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
39 <p align="justify">When the game ends, either by your death, when you quit,
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
40 or if you (by some miracle) manage to win, <u>rogue</u> will give you a list of the
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
41 top-ten scorers. The scoring is based entirely upon how much gold you get.
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
42 There is a 10% penalty for getting yourself killed.</p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
43
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
44 <p align="justify">For more detailed directions, read the document <u>A Guide
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
45 to the Dungeons of Doom</u>.</p>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
46
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
47 </blockquote>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
48
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
49 <h2>OPTIONS</h2>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
50 <blockquote>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
51
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
52 <p align="justify">If a <i>save_file</i> argument is given, <u>rogue</u> will attempt
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
53 to load a previously saved game from that file.</p>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
54 <p align="justify">With the <b>-n</b> option, <u>rogue</u> will load a game with the
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
55 name <i>playername</i> from a location defined at compile time. If no such
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
56 game exists, it will start one.</p>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
57 <p align="justify">The <b>-s</b> option prints the top-ten scores list and exits.</p>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
58 </blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
59
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
60 <h2>FILES</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
61 <blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
62 <table border="0" id="table1">
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
63 <tr>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
64 <td>/usr/local/games/roguelike/rogue3.scr</td>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
65 <td width="50">&nbsp;</td>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
66 <td>Score file</td>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
67 </tr>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
68 <tr>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
69 <td>~/rogue3.save</td>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
70 <td>&nbsp;</td>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
71 <td>Default save file</td>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
72 </tr>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
73 <tr>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
74 <td>/usr/local/games/roguelike/rogue3save</td>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
75 <td>&nbsp;</td>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
76 <td>System savefiles</td>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
77 </tr>
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
78 </table>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
79 </blockquote>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
80
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
81 <h2>SEE ALSO</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
82 <p>Michael C. Toy, <u>A Guide to the Dungeons of Doom</u></p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
83
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
84 <h2>BUGS</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
85 <p>Probably infinite. Currently known bugs are: Sometimes you are still
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
86 hungry even after you eat food and sometimes you get a monster on the
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
87 screen in reverse video which may or may not cause a core dump.</p>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
88
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
89 <h2>COPYRIGHT</h2>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
90 Rogue: Exploring the Dungeons of Doom<br>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
91 Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman <br>
9
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
92 All rights reserved.<br>
38acf3eb27e6 Update the documentation
edwarj4
parents: 0
diff changeset
93 License: 3-clause BSD, see LICENSE.txt for details.
0
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
94
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
95 </body>
527e2150eaf0 Import Rogue 3.6 from the Roguelike Restoration Project (r1490)
edwarj4
parents:
diff changeset
96 </html>