From: Eric S. Raymond Date: Tue, 7 Mar 2023 04:51:52 +0000 (-0500) Subject: Documentation polishing. X-Git-Tag: 1.14~7 X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=commitdiff_plain;h=e1ce7d6b6a02e19f0a15ae8fc61a44060843dcc4 Documentation polishing. --- diff --git a/NEWS b/NEWS index bed01bc..8e588fa 100644 --- a/NEWS +++ b/NEWS @@ -2,6 +2,7 @@ Repository head:: Added -a option for BBS door systems. + -o reverts to the old message on some failed magic words. 1.13: 2023-02-28:: Fixed slightly buggy emission of end-of-game messages on a win. @@ -17,7 +18,7 @@ Repository head:: 1.10: 2022-04-06:: 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. 1.9: 2020-08-27:: diff --git a/advent.adoc b/advent.adoc index d2b60d6..6257e6c 100644 --- a/advent.adoc +++ b/advent.adoc @@ -8,7 +8,7 @@ advent - Colossal Cave Adventure *advent* [-l logfile] [-o] [-r savefile] [script...] == 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 roleplaying games. @@ -18,19 +18,21 @@ adventure". To learn more about the changes since the 350-point original, type 'news' at the command prompt. 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 PDP-10 on which the game originally ran limited filenames to 6 characters. This version is released as open source with the permission and encouragement of the original authors. -Unlike the original, this version supports use of your arrow keys to edit -your command line in place. Basic Emacs keystrokes are supported, and -your up/down arrows access a command history. +Unlike the original, this version has a command prompt and supports +use of your arrow keys to edit your command line in place. Basic +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 -running Don's original. +Some minor bugs and message typos have been fixed. Otherwise, the +"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). @@ -44,12 +46,13 @@ There have been no gameplay changes. -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 case-smashes and truncates unrecognized text when echoed. 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. == BUGS == diff --git a/notes.adoc b/notes.adoc index 9a96003..45b3cd3 100644 --- a/notes.adoc +++ b/notes.adoc @@ -54,6 +54,7 @@ Bug fixes: * Behavior when saying the giant's magic words outside his room wasn't quite correct - the game responded as though the player were in 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. @@ -66,7 +67,7 @@ Bug fixes: "eying" for "eyeing". "thresholds" for "threshholds". * 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): @@ -98,6 +99,7 @@ that random events (dwarf & pirate appearances, the bird's magic word) will be reproducible. A "version" command has been added. This has no effect on gameplay. + The text displayed by the "news" command has been updated. 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 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 ways: