notes.adoc

   1 = Open Adventure Maintainer's Notes =
   2 by Eric S. Raymond
   3
   4 In which we explain what has been done to this code since Don Woods
   5 authorized us to ship it under an open-source license.  There's a
   6 separate link:history.html[history] describing how it came to us.
   7
   8 == Who we are ==
   9
  10 The principal maintainers of this code are Eric S. Raymond and Jason
  11 Ninneman.  Eric received Don Woods's encouragement to update and ship
  12 the game; Jason signed on early in the process to help. The assistance
  13 of Peje Nilsson in restructuring some particularly grotty gotos is
  14 gratefully acknowledged. Petr Voropaev contributed fuzz testing and
  15 code cleanups. Aaron Traas did a lot of painstaking work to improve
  16 test coverage, and factored out the last handful of gotos.
  17
  18 == Nomenclature ==
  19
  20 This project is called "Open Adventure" because it's not at all clear
  21 to number Adventure past 2.5 without misleading or causing
  22 collisions. Various of the non-mainline versions have claimed to be
  23 versions 3, 4, 5, 6, 7 and for all I know higher than that.  It seems
  24 best just to start a new numbering series while acknowledging the
  25 links back.
  26
  27 We have reverted to "advent" for the binary to avoid a name collision
  28 with the BSD Games version.
  29
  30 == Philosophy ==
  31
  32 Extreme care has been taken not to make changes that would alter the
  33 logic of the game as we received it from Don Woods, except to fix
  34 glitches that were clearly bugs.  By policy, all user-visible
  35 changes to gameplay must be revertible with the -o (oldstyle) option.
  36
  37 It is a goal of this project to exactly preserve the *intended
  38 behavior* of 430-point Adventure, but the implementation of it is fair
  39 game for improvement. In particular, we are concerned to move it to a
  40 form that is (a) readable, and (b) friendly to forward translation to
  41 future languages.  It has already survived a move from FORTRAN to C; a
  42 future as a Python or Go translation seems possible, even probable.
  43
  44 == Functional changes ==
  45
  46 Bug fixes:
  47
  48 * The caged bird used to be counted as two items in your inventory.
  49
  50 * Reading the relocated Witt's End sign in the endgame didn't work right.
  51
  52 * Oyster was readable after first gotten even when not carried.
  53
  54 * Behavior when saying the giant's magic words outside his room wasn't
  55   quite correct - the game responded as though the player were in
  56   the room ("...can't you read?"). The new message is "Nothing happens."
  57
  58 * Attempting to extinguish an unlit urn caused it to lose its oil.
  59
  60 * "A crystal bridge now spans the fissure." (progressive present) was
  61   incorrect most places it appeared and has been replaced by "A crystal
  62   bridge spans the fissure." (timeless present).
  63
  64 * A few minor typos have been corrected: absence of capitalization on
  65   "Swiss" and "Persian", inconsistent selling of "imbedded" vs. "embedded",
  66   "eying" for "eyeing". "thresholds" for "threshholds".
  67
  68 * Under odd circumstances (dropping rug or vase outdoors) the game could
  69   say "floor" when it should say "ground" (or "dirt", or something).
  70
  71 Bugs (accidental changes that don't seem worth the effort to fix):
  72
  73 * Commands that are not moves (e.g. "look" and "inven") can be used
  74   during fee fie fo foo without breaking recognition of the sequence.
  75
  76 * Bird starts uncaged in the endgame.
  77
  78 Enhancements:
  79
  80 By default, advent issues "> " as a command prompt.  This feature
  81 became common in many variants after the original 350-point version,
  82 but was never backported into Crowther & Woods's main line before now.
  83 The "-o" (oldstyle) option reverts the behavior.
  84
  85 There is a set of standard one-letter command aliases conventional in modern
  86 text adventure games; 'l' and 'x'; for 'look' (or 'examine'), 'z' to do nothing
  87 for a turn, 'i' for 'inventory', 'g' for 'get', and 'd' for 'drop'.  The 'd'
  88 alias collides with 'd' for 'down', but the others have been implemented.
  89 The "-o" (oldstyle) option disables them.
  90
  91 Unrecognized words are no longer truncated to 5 characters and
  92 uppercased when they are echoed. The "-o" (oldstyle) option restores
  93 this behavior.
  94
  95 A "seed" command has been added.  This is not intended for human use
  96 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
  97 that random events (dwarf & pirate appearances, the bird's magic word)
  98 will be reproducible.
  99
 100 A "version" command has been added. This has no effect on gameplay.
 101 The text displayed by the "news" command has been updated.
 102
 103 A -l command-line option has been added. When this is given (with a
 104 file path argument) each command entered will be logged to the
 105 specified file.  Additionally, a generated "seed" command will be put
 106 early in the file capturing the randomized start state of the PRNG
 107 so that replays of the log will be reproducible.
 108
 109 Using "seed" and -l, the distribution now includes a regression-test
 110 suite for the game.  Any log captured with -l (and thus containing
 111 a "seed" command) will replay reliably, including random events.
 112
 113 The adventure.text file is no longer required at runtime.  Instead, an
 114 adventure.yaml file is compiled at build time to a source module
 115 containing C structures, which is then linked to the advent
 116 binary.  The YAML is drastically easier to read and edit than
 117 the old ad-hoc format of adventure.txt.
 118
 119 The game-save format has changed.  This was done to simplify the
 120 FORTRAN-derived code that formerly implemented the save/restore
 121 functions; without C's fread(3)/fwrite() and structs it was
 122 necessarily pretty ugly by modern standards. Encryption and
 123 checksumming have been discarded - it's pointless to try
 124 tamper-proofing saves when everyone has the source code.
 125
 126 A -r command-line option has been added. When it is given (with a file
 127 path argument) it is functionally equivalent to a RESTORE command.
 128
 129 == Translation ==
 130
 131 The 2.5 code was a mechanical C translation of a FORTRAN original.
 132 There were gotos everywhere and the code was, though functional,
 133 ugly and quite unreadable.
 134
 135 Jason Ninneman and I have moved it to what is almost, but not quite,
 136 idiomatic modern C.  We refactored the right way, checking correctness
 137 against a comprehensive test suite that we built first and verified
 138 with coverage tools (there is effectively 100% code coverage). This is
 139 what you are running when you do "make check".
 140
 141 The move to modern C entailed some structural changes.  The most
 142 important was the refactoring of over 350 gotos into if/loop/break
 143 structures.  We also abolished almost all shared globals; the main one
 144 left is a struct holding the game's saveable/restorable state.
 145
 146 The original code was greatly complicated by a kind of bit-packing
 147 that was performed because the FORTRAN it was written in had no string
 148 type.  Text from the adventure.text file was compiled into sequences
 149 of sixbit code points in a restricted character set, packed 5 to a
 150 32-bit word (and it seems clear from the code that words were originally
 151 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 152 verb was one of these words, and what would be string operations in a
 153 more recent language were all done on sequences of these words.
 154
 155 We have removed all this bit-packing cruft in favor of proper C
 156 strings.  C strings may be a weak and leaky abstraction, but this is
 157 one of the rare cases in which they are an obvious improvement over
 158 what they're displacing...
 159
 160 We have also conducted extensive fuzz testing on the game using
 161 afl (American Fuzzy Lop).  We've found and fixed some crashers in
 162 our new code (which occasionally uses malloc(3)), but none as yet
 163 in Don's old code (which didn't).
 164
 165 The code falls short of being fully modern C in the following
 166 ways:
 167
 168 * We have not attempted to translate the old code to pointer-based
 169   idioms (as opposed, in particular, to integer-based array indexing).
 170   We don't need whatever minor performance gains this might collect,
 171   and the choice to refrain will make forward translation into future
 172   languages easier.
 173
 174 * Linked lists (for objects at a location) are implemented using an array
 175   of link indices. This is a surviving FORTRANism that is quite unlike
 176   normal practice in C or any more modern language.  We have not tried
 177   to fix it because doing so would (a) be quite difficult, and (b)
 178   compromise forward-portability to other languages.
 179
 180 * Much of the code still assumes one-origin array indexing.  Thus,
 181   arrays are a cell larger than they strictly need to be and cell 0 is
 182   unused.
 183
 184 We have made exactly one minor architectural change.  In addition to the
 185 old code's per-object state-description messages, we now have a per-object
 186 message series for state *changes*.  This makes it possible to pull a fair
 187 amount of text out of the arbitrary-messages list and associate those
 188 messages with the objects that conceptually own them.
 189
 190 == Development status ==
 191
 192 We consider this project finished. All issues and TODOs have been
 193 cleared, behavior has been carefully checked against original ADVENT,
 194 no future demand for new features is expected, and the test suite has
 195 100% code coverage.  If the toolchain bit-rots out from under it,
 196 we will fix that.
 197
 198 // end