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   The -o option reverts this change.
  58
  59 * Attempting to extinguish an unlit urn caused it to lose its oil.
  60
  61 * "A crystal bridge now spans the fissure." (progressive present) was
  62   incorrect most places it appeared and has been replaced by "A crystal
  63   bridge spans the fissure." (timeless present).
  64
  65 * A few minor typos have been corrected: absence of capitalization on
  66   "Swiss" and "Persian", inconsistent spelling of "imbedded" vs. "embedded",
  67   "eying" for "eyeing". "thresholds" for "threshholds".
  68
  69 * Under odd circumstances (dropping rug or vase outdoors) the game could
  70   formerly say "floor" when it should say "ground" (or "dirt", or something).
  71
  72 Bugs (accidental changes that don't seem worth the effort to fix):
  73
  74 * Bird starts uncaged in the endgame.
  75
  76 Enhancements:
  77
  78 By default, advent issues "> " as a command prompt.  This feature
  79 became common in many variants after the original 350-point version,
  80 but was never backported into Crowther & Woods's main line before now.
  81 The "-o" (oldstyle) option reverts the behavior.
  82
  83 There is a set of standard one-letter command aliases conventional in modern
  84 text adventure games; 'l' and 'x'; for 'look' (or 'examine'), 'z' to do nothing
  85 for a turn, 'i' for 'inventory', 'g' for 'get', and 'd' for 'drop'.  The 'd'
  86 alias collides with 'd' for 'down', but the others have been implemented.
  87 The "-o" (oldstyle) option disables them.
  88
  89 Unrecognized words are no longer truncated to 5 characters and
  90 uppercased when they are echoed. The "-o" (oldstyle) option restores
  91 this behavior.
  92
  93 A "seed" command has been added.  This is not intended for human use
  94 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
  95 that random events (dwarf & pirate appearances, the bird's magic word)
  96 will be reproducible.
  97
  98 A "version" command has been added. This has no effect on gameplay.
  99
 100 The text displayed by the "news" command has been updated.
 101
 102 A -l command-line option has been added. When this is given (with a
 103 file path argument) each command entered will be logged to the
 104 specified file.  Additionally, a generated "seed" command will be put
 105 early in the file capturing the randomized start state of the PRNG
 106 so that replays of the log will be reproducible.
 107
 108 Using "seed" and -l, the distribution now includes a regression-test
 109 suite for the game.  Any log captured with -l (and thus containing
 110 a "seed" command) will replay reliably, including random events.
 111
 112 The adventure.text file is no longer required at runtime.  Instead, an
 113 adventure.yaml file is compiled at build time to a source module
 114 containing C structures, which is then linked to the advent
 115 binary.  The YAML is drastically easier to read and edit than
 116 the old ad-hoc format of adventure.txt.
 117
 118 The game-save format has changed.  This was done to simplify the
 119 FORTRAN-derived code that formerly implemented the save/restore
 120 functions; without C's fread(3)/fwrite() and structs it was
 121 necessarily pretty ugly by modern standards. Encryption and
 122 checksumming have been discarded - it's pointless to try
 123 tamper-proofing saves when everyone has the source code.
 124
 125 A -r command-line option has been added. When it is given (with a file
 126 path argument) it is functionally equivalent to a RESTORE command.
 127
 128 The game can be built in a mode that entirely disables save/resume, or
 129 thart autosaves only on a termination signal (for use in BBS doort
 130 systems).  There is a new nmessage to inform the user about this.
 131
 132 == Translation ==
 133
 134 The 2.5 code was a mechanical C translation of a FORTRAN original.
 135 There were gotos everywhere and the code was, though functional,
 136 ugly and quite unreadable.
 137
 138 Jason Ninneman and I have moved it to what is almost, but not quite,
 139 idiomatic modern C.  We refactored the right way, checking correctness
 140 against a comprehensive test suite that we built first and verified
 141 with coverage tools (there is effectively 100% code coverage). This is
 142 what you are running when you do "make check".
 143
 144 The move to modern C entailed some structural changes.  The most
 145 important was the refactoring of over 350 gotos into if/loop/break
 146 structures.  We also abolished almost all shared globals; the main one
 147 left is a struct holding the game's saveable/restorable state.
 148
 149 The original code was greatly complicated by a kind of bit-packing
 150 that was performed because the FORTRAN it was written in had no string
 151 type.  Text from the adventure.text file was compiled into sequences
 152 of sixbit code points in a restricted character set, packed 5 to a
 153 32-bit word (and it seems clear from the code that words were originally
 154 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 155 verb was one of these words, and what would be string operations in a
 156 more recent language were all done on sequences of these words.
 157
 158 We have removed all this bit-packing cruft in favor of proper C
 159 strings.  C strings may be a weak and leaky abstraction, but this is
 160 one of the rare cases in which they are an obvious improvement over
 161 what they're displacing...
 162
 163 We have also conducted extensive fuzz testing on the game using
 164 afl (American Fuzzy Lop).  We've found and fixed some crashers in
 165 our new code (which occasionally uses malloc(3)), but none as yet
 166 in Don's old code (which didn't).
 167
 168 After version 1.11, correctness was carefully checked against the
 169 behavior of a binary from before the big refactoring.
 170
 171 The code falls short of being fully modern C in the following
 172 ways:
 173
 174 * We have not attempted to translate the old code to pointer-based
 175   idioms (as opposed, in particular, to integer-based array indexing).
 176   We don't need whatever minor performance gains this might collect,
 177   and the choice to refrain will make forward translation into future
 178   languages easier.
 179
 180 * Linked lists (for objects at a location) are implemented using an array
 181   of link indices. This is a surviving FORTRANism that is quite unlike
 182   normal practice in C or any more modern language.  We have not tried
 183   to fix it because doing so would (a) be quite difficult, and (b)
 184   compromise forward-portability to other languages.
 185
 186 * Much of the code still assumes one-origin array indexing.  Thus,
 187   arrays are a cell larger than they strictly need to be and cell 0 is
 188   unused.
 189
 190 We have made exactly one minor architectural change.  In addition to the
 191 old code's per-object state-description messages, we now have a per-object
 192 message series for state *changes*.  This makes it possible to pull a fair
 193 amount of text out of the arbitrary-messages list and associate those
 194 messages with the objects that conceptually own them.
 195
 196 == Development status ==
 197
 198 We consider this project finished. All issues and TODOs have been
 199 cleared, behavior has been carefully checked against original ADVENT,
 200 no future demand for new features is expected, and the test suite has
 201 100% code coverage.  If new bugs appear the toolchain bit-rots out
 202 from under underneath, we will fix those problems.
 203
 204 // end