Document a bugfix.

[open-adventure.git] / notes.adoc

diff --git a/notes.adoc b/notes.adoc
index 14ba9e30438206c6b2de68235f8fbe04f9ac7d10..3b3428e62f08e549ee309bf0b3b48e5b7b54ddb9 100644 (file)
--- a/notes.adoc
+++ b/notes.adoc
@@ -45,12 +45,16 @@ future as a Python or Go translation seems possible, even probable.
 
 Bug fixes:
 
 
 Bug fixes:
 

+* The caged bird used to be counted as two items in your inventory.
+

 * Reading the relocated Witt's End sign in the endgame didn't work right.
 
 * Reading the relocated Witt's End sign in the endgame didn't work right.
 

+* 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
 * 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 "Well, that was
-  remarkably pointless."
+  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.
 


@@ -59,11 +63,17 @@ Bug fixes:
   bridge spans the fissure." (timeless present).
 
 * A few minor typos have been corrected: absence of capitalization on
   bridge spans the fissure." (timeless present).
 
 * A few minor typos have been corrected: absence of capitalization on

-  "Swiss" and "Persian", inconsistent selling of "imbedded" vs. "embedded",
+  "Swiss" and "Persian", inconsistent spelling of "imbedded" vs. "embedded",

   "eying" for "eyeing". "thresholds" for "threshholds".
 
 * Under odd circumstances (dropping rug or vase outdoors) the game could
   "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):
+
+* Bird starts uncaged in the endgame.
+
+Enhancements:

 
 By default, advent issues "> " as a command prompt.  This feature
 became common in many variants after the original 350-point version,
 
 By default, advent issues "> " as a command prompt.  This feature
 became common in many variants after the original 350-point version,


@@ -85,6 +95,10 @@ but as a way for game logs to set the PRNG (pseudorandom-number generator) so
 that random events (dwarf & pirate appearances, the bird's magic word)
 will be reproducible.
 
 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
 file path argument) each command entered will be logged to the
 specified file.  Additionally, a generated "seed" command will be put
 A -l command-line option has been added. When this is given (with a
 file path argument) each command entered will be logged to the
 specified file.  Additionally, a generated "seed" command will be put


@@ -111,6 +125,10 @@ tamper-proofing saves when everyone has the source code.
 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.
 
 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.
+

 == Translation ==
 
 The 2.5 code was a mechanical C translation of a FORTRAN original.
 == Translation ==
 
 The 2.5 code was a mechanical C translation of a FORTRAN original.


@@ -147,6 +165,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).
 
 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:
 
 The code falls short of being fully modern C in the following
 ways:
 


@@ -166,14 +187,18 @@ ways:
   arrays are a cell larger than they strictly need to be and cell 0 is
   unused.
 
   arrays are a cell larger than they strictly need to be and cell 0 is
   unused.
 

-* The code is still mostly typeless, slinging around machine longs
-  like a FORTRAN or BCPL program.  Some (incomplete) effort has been made
-  to introduce semantic types.
-

 We have made exactly one minor architectural change.  In addition to the
 old code's per-object state-description messages, we now have a per-object
 message series for state *changes*.  This makes it possible to pull a fair
 amount of text out of the arbitrary-messages list and associate those
 messages with the objects that conceptually own them.
 
 We have made exactly one minor architectural change.  In addition to the
 old code's per-object state-description messages, we now have a per-object
 message series for state *changes*.  This makes it possible to pull a fair
 amount of text out of the arbitrary-messages list and associate those
 messages with the objects that conceptually own them.
 

+== Development status ==
+
+We consider this project finished. All issues and TODOs have been
+cleared, behavior has been carefully checked against original ADVENT,
+no future demand for new features is expected, and the test suite has
+100% code coverage.  If new bugs appear the toolchain bit-rots out
+from under underneath, we will fix those problems.
+

 // end
 // end