Documentation polishing.
[open-adventure.git] / notes.adoc
index 3c568ce008a42b11bef13e28cec034b1365e1bfc..f2359bd065e6a88b98e4849a79909142bd4d4227 100644 (file)
@@ -45,12 +45,15 @@ future as a Python or Go translation seems possible, even probable.
 
 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.
 
+* 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 "Well, that was
-  remarkably pointless."
+  the room ("...can't you read?"). The new message is "Nothing happens."
  
 * Attempting to extinguish an unlit urn caused it to lose its oil.
 
@@ -58,9 +61,18 @@ Bug fixes:
   incorrect most places it appeared and has been replaced by "A crystal 
   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",
+  "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).
 
+* Bird starts uncaged in the endgame. This is an accidental change
+  that doesn't seem worth the effort to fix.
+
+Enhancements:
+
 By default, advent issues "> " as a command prompt.  This feature
 became common in many variants after the original 350-point version,
 but was never backported into Crowther & Woods's main line before now.
@@ -81,6 +93,9 @@ 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.
 
+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
@@ -128,7 +143,7 @@ The original code was greatly complicated by a kind of bit-packing
 that was performed because the FORTRAN it was written in had no string
 type.  Text from the adventure.text file was compiled into sequences
 of sixbit code points in a restricted character set, packed 5 to a
-32-bit word (it seems clear from the code that words were originally
+32-bit word (and it seems clear from the code that words were originally
 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 verb was one of these words, and what would be string operations in a
 more recent language were all done on sequences of these words.
@@ -162,14 +177,18 @@ ways:
   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.
 
+== 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 the toolchain bit-rots out from under it,
+we will fix that.
+
 // end