Add some SPDX headers.
[open-adventure.git] / notes.adoc
index 9a9600304ef43fb75a4713ac7c63828f58b7832b..c6759ac8a8452ab5ab0688586dcb70923625ccaa 100644 (file)
@@ -1,5 +1,7 @@
 = Open Adventure Maintainer's Notes =
 by Eric S. Raymond
+// SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
+// SPDX-License-Identifier: CC-BY-4.0
 
 In which we explain what has been done to this code since Don Woods
 authorized us to ship it under an open-source license.  There's a
@@ -51,10 +53,13 @@ Bug fixes:
 
 * Oyster was readable after first gotten even when not carried.
 
-* 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."
+* Response to an attempt to unlock the oyster while carrying it was incorrect. 
+
+* Behavior when saying the giant's magic words before having seen them wasn't
+  quite correct - the game responded as though the player had already
+  read them ("...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.
 
 * "A crystal bridge now spans the fissure." (progressive present) was
@@ -63,17 +68,10 @@ Bug fixes:
 
 * A few minor typos have been corrected: absence of capitalization on
   "Swiss" and "Persian", inconsistent spelling of "imbedded" vs. "embedded",
-  "eying" for "eyeing". "thresholds" for "threshholds".
+  "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).
-
-Bugs (accidental changes that don't seem worth the effort to fix):
-
-* Commands that are not moves (e.g. "look" and "inven") can be used
-  during fee fie fo foo without breaking recognition of the sequence.
-
-* Bird starts uncaged in the endgame.
+  formerly say "floor" when it should say "ground" (or "dirt", or something).
 
 Enhancements:
 
@@ -98,6 +96,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
@@ -121,14 +120,24 @@ FORTRAN-derived code that formerly implemented the save/restore
 functions; without C's fread(3)/fwrite() and structs it was
 necessarily pretty ugly by modern standards. Encryption and
 checksumming have been discarded - it's pointless to try
-tamper-proofing saves when everyone has the source code.
+tamper-proofing saves when everyone has the source code. However
+the game still integrity-checks savefiles on resume.
+
+Save and resume filenames are stripped of leading and trailing
+whitespace before processing.
 
 A -r command-line option has been added. When it is given (with a file
 path argument) it is functionally equivalent to a RESTORE command.
 
-The game can be built in a mode that entirely disables save/resume, or
-thart autosaves only on a termination signal (for use in BBS doort
-systems).  There is a new nmessage to inform the user about this.
+An -a command-line option has been added (comditionally on
+ADVENT_AUTOSAVE) for use in BBS door systems.  When this option is
+given, the game roads from the specified filename argument on startup
+and saves to it on quit or a received signal. There is a new nmessage
+to inform the user about this.
+
+The game can be built in a mode that entirely disables save/resume
+(-DADVENT_NOSAVE). If the game had been built this way, a diagnostic is
+emitted if you try to save or resume.
 
 == Translation ==
 
@@ -166,6 +175,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: