archives/open-adventure
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation polishing.

Browse source
This commit is contained in:
Eric S. Raymond 2023-03-06 23:51:52 -05:00
parent f911e42453
commit e1ce7d6b6a
3 changed files with 20 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

3
NEWS
View file

@ -2,6 +2,7 @@
Repository head:: Repository head::
Added -a option for BBS door systems. Added -a option for BBS door systems.
-o reverts to the old message on some failed magic words.
1.13: 2023-02-28:: 1.13: 2023-02-28::
Fixed slightly buggy emission of end-of-game messages on a win. Fixed slightly buggy emission of end-of-game messages on a win.
@ -17,7 +18,7 @@ Repository head::
1.10: 2022-04-06:: 1.10: 2022-04-06::
Fixed a bug that manifested after two "fly rug" commands - third one fails. Fixed a bug that manifested after two "fly rug" commands - third one fails.
Fix some giltches in processing fee fie foe foo. Fix some glitches in processing fee fie foe foo.
Correct some object start states and reading-related glitches in the endgame. Correct some object start states and reading-related glitches in the endgame.
1.9: 2020-08-27:: 1.9: 2020-08-27::

21
advent.adoc
View file

@ -8,7 +8,7 @@ advent - Colossal Cave Adventure
*advent* [-l logfile] [-o] [-r savefile] [script...] *advent* [-l logfile] [-o] [-r savefile] [script...]
== DESCRIPTION == == DESCRIPTION ==
The original Colossal Cave Adventure from 1976-77 was the origin of all The original Colossal Cave Adventure from 1976-1977 was the origin of all
later text adventures, dungeon-crawl (computer) games, and computer-hosted later text adventures, dungeon-crawl (computer) games, and computer-hosted
roleplaying games. roleplaying games.
@ -18,19 +18,21 @@ adventure". To learn more about the changes since the 350-point
original, type 'news' at the command prompt. original, type 'news' at the command prompt.
There is an 'adventure' in the BSD games package that is a C port by There is an 'adventure' in the BSD games package that is a C port by
Jim Gillogly of the 1976 ancestor of this game. To avoid a name Jim Gillogly of the Don Woods's 1977 version of this game. To avoid a name
collision, this game builds as 'advent', reflecting the fact that the collision, this game builds as 'advent', reflecting the fact that the
PDP-10 on which the game originally ran limited filenames to 6 characters. PDP-10 on which the game originally ran limited filenames to 6 characters.
This version is released as open source with the permission and This version is released as open source with the permission and
encouragement of the original authors. encouragement of the original authors.
Unlike the original, this version supports use of your arrow keys to edit Unlike the original, this version has a command prompt and supports
your command line in place. Basic Emacs keystrokes are supported, and use of your arrow keys to edit your command line in place. Basic
your up/down arrows access a command history. Emacs keystrokes are supported, and your up/down arrows access a
command history.
Otherwise, the "version" command is about the only way to tell you're not Some minor bugs and message typos have been fixed. Otherwise, the
running Don's original. "version" command is almost the only way to tell you're not running
Don's 1977 version.
To exit the game, type Ctrl-D (EOF). To exit the game, type Ctrl-D (EOF).
@ -44,12 +46,13 @@ There have been no gameplay changes.
-a:: Load from specified file and autosave to it on exit or signal. -a:: Load from specified file and autosave to it on exit or signal.
-o:: Old-style. Restores original interface, no prompt or line editing. -o:: Old-style. Reverts some minor cosmetic fixes in game
messages. Restores original interface, no prompt or line editing.
Also ignores new-school one-letter commands l, x, g, z, i. Also Also ignores new-school one-letter commands l, x, g, z, i. Also
case-smashes and truncates unrecognized text when echoed. case-smashes and truncates unrecognized text when echoed.
Normally, game input is taken from standard input. If script file Normally, game input is taken from standard input. If script file
arguments are given, input is taken fron them instead. A script file arguments are given, input is taken from them instead. A script file
argument of '-' is taken as a directive to read from standard input. argument of '-' is taken as a directive to read from standard input.
== BUGS == == BUGS ==

7
notes.adoc
View file

@ -54,6 +54,7 @@ Bug fixes:
* Behavior when saying the giant's magic words outside his room wasn't * Behavior when saying the giant's magic words outside his room wasn't
quite correct - the game responded as though the player were in quite correct - the game responded as though the player were in
the room ("...can't you read?"). The new message is "Nothing happens." the room ("...can't you read?"). The new message is "Nothing happens."
The -o option reverts this change.
* Attempting to extinguish an unlit urn caused it to lose its oil. * Attempting to extinguish an unlit urn caused it to lose its oil.
@ -66,7 +67,7 @@ Bug fixes:
"eying" for "eyeing". "thresholds" for "threshholds". "eying" for "eyeing". "thresholds" for "threshholds".
* Under odd circumstances (dropping rug or vase outdoors) the game could * Under odd circumstances (dropping rug or vase outdoors) the game could
say "floor" when it should say "ground" (or "dirt", or something). formerly say "floor" when it should say "ground" (or "dirt", or something).
Bugs (accidental changes that don't seem worth the effort to fix): Bugs (accidental changes that don't seem worth the effort to fix):
@ -98,6 +99,7 @@ that random events (dwarf & pirate appearances, the bird's magic word)
will be reproducible. will be reproducible.
A "version" command has been added. This has no effect on gameplay. A "version" command has been added. This has no effect on gameplay.
The text displayed by the "news" command has been updated. The text displayed by the "news" command has been updated.
A -l command-line option has been added. When this is given (with a A -l command-line option has been added. When this is given (with a
@ -166,6 +168,9 @@ afl (American Fuzzy Lop). We've found and fixed some crashers in
our new code (which occasionally uses malloc(3)), but none as yet our new code (which occasionally uses malloc(3)), but none as yet
in Don's old code (which didn't). in Don's old code (which didn't).
After version 1.11, correctness was carefully checked against the
behavior of a binary from before the big refactoring.
The code falls short of being fully modern C in the following The code falls short of being fully modern C in the following
ways: ways: