notes.adoc

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