Coverage -- giant words

[open-adventure.git] / notes.adoc

diff --git a/notes.adoc b/notes.adoc
index 884d1ce7f7d5ff970e2ca331687afe5e17cffe67..be36ddc6fba1203755ab21a2a750519ef478509d 100644 (file)
--- a/notes.adoc
+++ b/notes.adoc
@@ -29,22 +29,39 @@ with the BSD Games version.
 == Philosophy ==
 
 Extreme care has been taken not to make changes that would alter the
 == Philosophy ==
 
 Extreme care has been taken not to make changes that would alter the

-logic of the game as we received it from Don Woods.  By policy, all
-user-visible changes must be revertible with the -o (oldstyle) option.
+logic of the game as we received it from Don Woods, except to fix
+glitches that were clearly bugs.  By policy, all user-visible
+changes must be revertible with the -o (oldstyle) option.

 
 

-It is a goal of this project to exactly preserve the *behavior* of
-430-point Adventure, but the implementation of it is fair game for
-improvement. In particular, we are concerned to move it to a form that
-is (a) readable, and (b) friendly to forward translation to future
-languages.  It has already survived a move from FORTRAN to C; a future
-as a Python or Go translation seems possible, even probable.
+It is a goal of this project to exactly preserve the *intended
+behavior* of 430-point Adventure, but the implementation of it is fair
+game for improvement. In particular, we are concerned to move it to a
+form that is (a) readable, and (b) friendly to forward translation to
+future languages.  It has already survived a move from FORTRAN to C; a
+future as a Python or Go translation seems possible, even probable.

 
 == Functional changes ==
 
 
 == Functional changes ==
 

+Bug fixes:
+
+* Reading the relocated Witt's End sign in the endgame didn't work right.
+
+* Behavior when saying the giant's magic words outside his room wasn't
+  quite corrected - the game responded as though the player were in
+  the room.
+ 
+* Attempting to extinguish an unlit urn caused it to lose its oil.
+

 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.
 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.

-The "-o" (oldstyle) version reverts the behavior.
+The "-o" (oldstyle) option reverts the behavior.
+
+There is a set of standard one-letter command aliases conventional in modern
+text adventure games; 'l' and 'x'; for 'look' (or 'examine'), 'z' to do nothing
+for a turn, 'i' for 'inventory', 'g' for 'get', and 'd' for 'drop'.  The 'd'
+alias collides with 'd' for 'down', but the others have been implemented.
+The "-o" (oldstyle) option disables them.

 
 A "seed" command has been added.  This is not intended for human use
 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
 
 A "seed" command has been added.  This is not intended for human use
 but as a way for game logs to set the PRNG (pseudorandom-number generator) so


@@ -86,14 +103,10 @@ ugly and quite unreadable.
 Jason Ninneman and I have moved it to what is almost, but not quite,
 idiomatic modern C.  We refactored the right way, checking correctness
 against a comprehensive test suite that we built first and verified
 Jason Ninneman and I have moved it to what is almost, but not quite,
 idiomatic modern C.  We refactored the right way, checking correctness
 against a comprehensive test suite that we built first and verified

-with coverage tools (we now have over 95% coverage, with the remaining
+with coverage tools (we have over 95% coverage, with the remaining

 confined to exception cases that are very difficult to reach). This is
 what you are running when you do "make check".
 
 confined to exception cases that are very difficult to reach). This is
 what you are running when you do "make check".
 

-In the process we found and fixed a few minor bugs. Most notably, reading
-the relocated Witt's End sign in the endgame didn't work. Behavior when
-saying the giant's magic words outside his room wasn't quite right either.
-

 The move to modern C entailed some structural changes.  The most
 important was the refactoring of over 350 gotos into if/loop/break
 structures.  We also abolished almost all shared globals; the main one
 The move to modern C entailed some structural changes.  The most
 important was the refactoring of over 350 gotos into if/loop/break
 structures.  We also abolished almost all shared globals; the main one


@@ -148,7 +161,7 @@ ways:
 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
 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 test out of the arbitrary-messages list and associate those
+amount of text out of the arbitrary-messages list and associate those

 mesages with the objects that conceptually own them.
 
 // end
 mesages with the objects that conceptually own them.
 
 // end