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. Aaron
  15 Traas did a lot of painstaking work to improve test coverage.
  16
  17 == Nomenclature ==
  18
  19 This project is called "Open Adventure" because it's not at all clear
  20 to number Adventure past 2.5 without misleading or causing
  21 collisions. Various of the non-mainline versions have claimed to be
  22 versions 3, 4, 5, 6, 7 and for all I know higher than that.  It seems
  23 best just to start a new numbering series while acknowledging the
  24 links back.
  25
  26 We have reverted to "advent" for the binary to avoid a name collision
  27 with the BSD Games version.
  28
  29 == Philosophy ==
  30
  31 Extreme care has been taken not to make changes that would alter the
  32 logic of the game as we received it from Don Woods.  By policy, all
  33 user-visible changes must be revertible with the -o (oldstyle) option.
  34
  35 It is a goal of this project to exactly preserve the *behavior* of
  36 430-point Adventure, but the implementation of it is fair game for
  37 improvement. In particular, we are concerned to move it to a form that
  38 is (a) readable, and (b) friendly to forward translation to future
  39 languages.  It has already survived a move from FORTRAN to C; a future
  40 as a Python or Go translation seems possible, even probable.
  41
  42 == Functional changes ==
  43
  44 By default, advent issues "> " as a command prompt.  This feature
  45 became common in many variants after the original 350-point version,
  46 but was never backported into Crowther & Woods's main line before now.
  47 The "-o" (oldstyle) version reverts the behavior.
  48
  49 A "seed" command has been added.  This is not intended for human use
  50 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
  51 that random events (dwarf & pirate appearances, the bird's magic word)
  52 will be reproducible.
  53
  54 A -l command-line option has been added. When this is given (with a
  55 file path argument) each command entered will be logged to the
  56 specified file.  Additionally, a generated "seed" command will be put
  57 early in the file capturing the randomized start state of the PRNG
  58 so that replays of the log will be reproducible.
  59
  60 Using "seed" and -l, the distribution now includes a regression-test
  61 suite for the game.  Any log captured with -l (and thus containing
  62 a "seed" command) will replay reliably, including random events.
  63
  64 The adventure.text file is no longer required at runtime.  Instead, an
  65 adventure.yaml file is compiled at build time to a source module
  66 containing C structures, which is then linked to the advent
  67 binary.  The YAML is drastically easier to read and edit than
  68 the old ad-hoc format of adventure.txt.
  69
  70 The game-save format has changed.  This was done to simplify the
  71 FORTRAN-derived code that formerly implemented the save/restore
  72 functions; without C's fread(3)/fwrite() and structs it was
  73 necessarily pretty ugly by modern standards. Encryption and
  74 checksumming have been discarded - it's pointless to try
  75 tamper-proofing saves when everyone has the source code.
  76
  77 A -r command-line been added. When it is given (with a file path
  78 argument) it is functionally equivalent to a RESTORE command.
  79
  80 == Translation ==
  81
  82 The 2.5 code was a mechanical C translation of a FORTRAN original.
  83 There were gotos everywhere and the code was, though functional,
  84 ugly and quite unreadable.
  85
  86 Jason Ninneman and I have moved it to what is almost, but not quite,
  87 idiomatic modern C.  We refactored the right way, checking correctness
  88 against a comprehensive test suite that we built first and verified
  89 with coverage tools (we now have over 95% coverage, with the remaining
  90 confined to exception cases that are very difficult to reach). This is
  91 what you are running when you do "make check".
  92
  93 In the process we found and fixed a few minor bugs. Most notably, reading
  94 the relocated Witt's End sign in the endgame didn't work. Behavior when
  95 saying the giant's magic words outside his room wasn't quite right either.
  96 Attempt to extinguish dark urn would have cause it do lose oil.
  97
  98 The move to modern C entailed some structural changes.  The most
  99 important was the refactoring of over 350 gotos into if/loop/break
 100 structures.  We also abolished almost all shared globals; the main one
 101 left is a struct holding the game's saveable/restorable state.
 102
 103 The original code was greatly complicated by a kind of bit-packing
 104 that was performed because the FORTRAN it was written in had no string
 105 type.  Text from the adventure.text file was compiled into sequences
 106 of sixbit code points in a restricted character set, packed 5 to a
 107 32-bit word (it seems clear from the code that words were originally
 108 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 109 verb was one of these words, and what would be string operations in a
 110 more recent language were all done on sequences of these words.
 111
 112 We have removed all this bit-packing cruft in favor of proper C
 113 strings.  C strings may be a weak and leaky abstraction, but this is
 114 one of the rare cases in which they are an obvious improvement over
 115 what they're displacing...
 116
 117 We have also conducted extensive fuzz testing on the game using
 118 afl (American Fuzzy Lop).  We've found and fixed some crashers in
 119 our new code (which occasionally uses malloc(3)), but none as yet
 120 in Don's old code (which didn't).
 121
 122 The code falls short of being fully modern C in the following
 123 ways:
 124
 125 * We have not attempted to translate the old code to pointer-based
 126   idioms (as opposed, in particular, to integer-based array indexing).
 127   We don't need whatever minor performance gains this might collect,
 128   and the choice to refrain will make forward translation into future
 129   languages easier.
 130
 131 * There are a few gotos left that resist restructuring; all are in the
 132   principal command interpreter function implementing its state
 133   machine.
 134
 135 * Linked lists (for objects at a location) are implemented using an array
 136   of link indices. This is a surviving FORTRANism that is quite unlike
 137   normal practice in C or any more modern language.  We have not tried
 138   to fix it because doing so would (a) be quite difficult, and (b)
 139   compromise forward-portability to other languages.
 140
 141 * Much of the code still assumes one-origin array indexing.  Thus,
 142   arrays are a cell larger than they strictly need to be and cell 0 is
 143   unused.
 144
 145 * The code is still mostly typeless, slinging around machine longs
 146   like a FORTRAN or BCPL program.  Some (incomplete) effort has been made
 147   to introduce semantic types.
 148
 149 We have made exactly one minor architectural change.  In addition to the
 150 old code's per-object state-description messages, we now have a per-object
 151 message series for state *changes*.  This makes it possible to pull a fair
 152 amount of test out of the arbitrary-messages list and associate those
 153 mesages with the objects that conceptually own them.
 154
 155 // end