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.
  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 * Reading the relocated Witt's End sign in the endgame didn't work right.
  49
  50 * Behavior when saying the giant's magic words outside his room wasn't
  51   quite correct - the game responded as though the player were in
  52   the room.
  53
  54 * Attempting to extinguish an unlit urn caused it to lose its oil.
  55
  56 * "A crystal bridge now spans the fissure." (progressive present) was
  57   incorrect most places it appeared and has been replaced by "A crystal
  58   bridge spans the fissure." (timeless present).
  59
  60 By default, advent issues "> " as a command prompt.  This feature
  61 became common in many variants after the original 350-point version,
  62 but was never backported into Crowther & Woods's main line before now.
  63 The "-o" (oldstyle) option reverts the behavior.
  64
  65 There is a set of standard one-letter command aliases conventional in modern
  66 text adventure games; 'l' and 'x'; for 'look' (or 'examine'), 'z' to do nothing
  67 for a turn, 'i' for 'inventory', 'g' for 'get', and 'd' for 'drop'.  The 'd'
  68 alias collides with 'd' for 'down', but the others have been implemented.
  69 The "-o" (oldstyle) option disables them.
  70
  71 Unrecognized words are no longer truncated to 5 characters and
  72 uppercased when they are echoed. The "-o" (oldstyle) option restores
  73 this behavior.
  74
  75 A "seed" command has been added.  This is not intended for human use
  76 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
  77 that random events (dwarf & pirate appearances, the bird's magic word)
  78 will be reproducible.
  79
  80 A -l command-line option has been added. When this is given (with a
  81 file path argument) each command entered will be logged to the
  82 specified file.  Additionally, a generated "seed" command will be put
  83 early in the file capturing the randomized start state of the PRNG
  84 so that replays of the log will be reproducible.
  85
  86 Using "seed" and -l, the distribution now includes a regression-test
  87 suite for the game.  Any log captured with -l (and thus containing
  88 a "seed" command) will replay reliably, including random events.
  89
  90 The adventure.text file is no longer required at runtime.  Instead, an
  91 adventure.yaml file is compiled at build time to a source module
  92 containing C structures, which is then linked to the advent
  93 binary.  The YAML is drastically easier to read and edit than
  94 the old ad-hoc format of adventure.txt.
  95
  96 The game-save format has changed.  This was done to simplify the
  97 FORTRAN-derived code that formerly implemented the save/restore
  98 functions; without C's fread(3)/fwrite() and structs it was
  99 necessarily pretty ugly by modern standards. Encryption and
 100 checksumming have been discarded - it's pointless to try
 101 tamper-proofing saves when everyone has the source code.
 102
 103 A -r command-line been added. When it is given (with a file path
 104 argument) it is functionally equivalent to a RESTORE command.
 105
 106 == Translation ==
 107
 108 The 2.5 code was a mechanical C translation of a FORTRAN original.
 109 There were gotos everywhere and the code was, though functional,
 110 ugly and quite unreadable.
 111
 112 Jason Ninneman and I have moved it to what is almost, but not quite,
 113 idiomatic modern C.  We refactored the right way, checking correctness
 114 against a comprehensive test suite that we built first and verified
 115 with coverage tools (we have over 95% coverage, with the remaining
 116 confined to exception cases that are very difficult to reach). This is
 117 what you are running when you do "make check".
 118
 119 The move to modern C entailed some structural changes.  The most
 120 important was the refactoring of over 350 gotos into if/loop/break
 121 structures.  We also abolished almost all shared globals; the main one
 122 left is a struct holding the game's saveable/restorable state.
 123
 124 The original code was greatly complicated by a kind of bit-packing
 125 that was performed because the FORTRAN it was written in had no string
 126 type.  Text from the adventure.text file was compiled into sequences
 127 of sixbit code points in a restricted character set, packed 5 to a
 128 32-bit word (it seems clear from the code that words were originally
 129 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 130 verb was one of these words, and what would be string operations in a
 131 more recent language were all done on sequences of these words.
 132
 133 We have removed all this bit-packing cruft in favor of proper C
 134 strings.  C strings may be a weak and leaky abstraction, but this is
 135 one of the rare cases in which they are an obvious improvement over
 136 what they're displacing...
 137
 138 We have also conducted extensive fuzz testing on the game using
 139 afl (American Fuzzy Lop).  We've found and fixed some crashers in
 140 our new code (which occasionally uses malloc(3)), but none as yet
 141 in Don's old code (which didn't).
 142
 143 The code falls short of being fully modern C in the following
 144 ways:
 145
 146 * We have not attempted to translate the old code to pointer-based
 147   idioms (as opposed, in particular, to integer-based array indexing).
 148   We don't need whatever minor performance gains this might collect,
 149   and the choice to refrain will make forward translation into future
 150   languages easier.
 151
 152 * There are a few gotos left that resist restructuring; all are in the
 153   principal command interpreter function implementing its state
 154   machine.
 155
 156 * Linked lists (for objects at a location) are implemented using an array
 157   of link indices. This is a surviving FORTRANism that is quite unlike
 158   normal practice in C or any more modern language.  We have not tried
 159   to fix it because doing so would (a) be quite difficult, and (b)
 160   compromise forward-portability to other languages.
 161
 162 * Much of the code still assumes one-origin array indexing.  Thus,
 163   arrays are a cell larger than they strictly need to be and cell 0 is
 164   unused.
 165
 166 * The code is still mostly typeless, slinging around machine longs
 167   like a FORTRAN or BCPL program.  Some (incomplete) effort has been made
 168   to introduce semantic types.
 169
 170 We have made exactly one minor architectural change.  In addition to the
 171 old code's per-object state-description messages, we now have a per-object
 172 message series for state *changes*.  This makes it possible to pull a fair
 173 amount of text out of the arbitrary-messages list and associate those
 174 mesages with the objects that conceptually own them.
 175
 176 // end