notes.adoc

   1 = Open Adventure Maintainer's Notes =
   2 by Eric S. Raymond
   3 // SPDX-FileCopyrightText: 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.
  19
  20 == Nomenclature ==
  21
  22 This project is called "Open Adventure" because it's not at all clear
  23 to number Adventure past 2.5 without misleading or causing
  24 collisions. Various of the non-mainline versions have claimed to be
  25 versions 3, 4, 5, 6, 7 and for all I know higher than that.  It seems
  26 best just to start a new numbering series while acknowledging the
  27 links back.
  28
  29 We have reverted to "advent" for the binary to avoid a name collision
  30 with the BSD Games version.
  31
  32 == Philosophy ==
  33
  34 Extreme care has been taken not to make changes that would alter the
  35 logic of the game as we received it from Don Woods, except to fix
  36 glitches that were clearly bugs.  By policy, all user-visible
  37 changes to gameplay must be revertible with the -o (oldstyle) option.
  38
  39 It is a goal of this project to exactly preserve the *intended
  40 behavior* of 430-point Adventure, but the implementation of it is fair
  41 game for improvement. In particular, we are concerned to move it to a
  42 form that is (a) readable, and (b) friendly to forward translation to
  43 future languages.  It has already survived a move from FORTRAN to C; a
  44 future as a Python or Go translation seems possible, even probable.
  45
  46 == Functional changes ==
  47
  48 Bug fixes:
  49
  50 * The caged bird used to be counted as two items in your inventory.
  51
  52 * Reading the relocated Witt's End sign in the endgame didn't work right.
  53
  54 * Oyster was readable after first gotten even when not carried.
  55
  56 * Response to an attempt to unlock the oyster while carrying it was incorrect.
  57
  58 * Behavior when saying the giant's magic words before having seen them wasn't
  59   quite correct - the game responded as though the player had already
  60   read them ("...can't you read?"). The new message is "Nothing happens."
  61   The -o option reverts this change.
  62
  63 * Attempting to extinguish an unlit urn caused it to lose its oil.
  64
  65 * "A crystal bridge now spans the fissure." (progressive present) was
  66   incorrect most places it appeared and has been replaced by "A crystal
  67   bridge spans the fissure." (timeless present).
  68
  69 * A few minor typos have been corrected: absence of capitalization on
  70   "Swiss" and "Persian", inconsistent spelling of "imbedded" vs. "embedded",
  71   "eying" for "eyeing", "thresholds" for "threshholds".
  72
  73 * Under odd circumstances (dropping rug or vase outdoors) the game could
  74   formerly say "floor" when it should say "ground" (or "dirt", or something).
  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. However
 124 the game still integrity-checks savefiles on resume.
 125
 126 Save and resume filenames are stripped of leading and trailing
 127 whitespace before processing.
 128
 129 A -r command-line option has been added. When it is given (with a file
 130 path argument) it is functionally equivalent to a RESTORE command.
 131
 132 An -a command-line option has been added (comditionally on
 133 ADVENT_AUTOSAVE) for use in BBS door systems.  When this option is
 134 given, the game roads from the specified filename argument on startup
 135 and saves to it on quit or a received signal. There is a new nmessage
 136 to inform the user about this.
 137
 138 The game can be built in a mode that entirely disables save/resume
 139 (-DADVENT_NOSAVE). If the game had been built this way, a diagnostic is
 140 emitted if you try to save or resume.
 141
 142 == Translation ==
 143
 144 The 2.5 code was a mechanical C translation of a FORTRAN original.
 145 There were gotos everywhere and the code was, though functional,
 146 ugly and quite unreadable.
 147
 148 Jason Ninneman and I have moved it to what is almost, but not quite,
 149 idiomatic modern C.  We refactored the right way, checking correctness
 150 against a comprehensive test suite that we built first and verified
 151 with coverage tools (there is effectively 100% code coverage). This is
 152 what you are running when you do "make check".
 153
 154 The move to modern C entailed some structural changes.  The most
 155 important was the refactoring of over 350 gotos into if/loop/break
 156 structures.  We also abolished almost all shared globals; the main one
 157 left is a struct holding the game's saveable/restorable state.
 158
 159 The original code was greatly complicated by a kind of bit-packing
 160 that was performed because the FORTRAN it was written in had no string
 161 type.  Text from the adventure.text file was compiled into sequences
 162 of sixbit code points in a restricted character set, packed 5 to a
 163 32-bit word (and it seems clear from the code that words were originally
 164 *6* chars each packed into a PDP-10 36-bit word).  A command noun or
 165 verb was one of these words, and what would be string operations in a
 166 more recent language were all done on sequences of these words.
 167
 168 We have removed all this bit-packing cruft in favor of proper C
 169 strings.  C strings may be a weak and leaky abstraction, but this is
 170 one of the rare cases in which they are an obvious improvement over
 171 what they're displacing...
 172
 173 We have also conducted extensive fuzz testing on the game using
 174 afl (American Fuzzy Lop).  We've found and fixed some crashers in
 175 our new code (which occasionally uses malloc(3)), but none as yet
 176 in Don's old code (which didn't).
 177
 178 After version 1.11, correctness was carefully checked against the
 179 behavior of a binary from before the big refactoring.
 180
 181 The code falls short of being fully modern C in the following
 182 ways:
 183
 184 * We have not attempted to translate the old code to pointer-based
 185   idioms (as opposed, in particular, to integer-based array indexing).
 186   We don't need whatever minor performance gains this might collect,
 187   and the choice to refrain will make forward translation into future
 188   languages easier.
 189
 190 * Linked lists (for objects at a location) are implemented using an array
 191   of link indices. This is a surviving FORTRANism that is quite unlike
 192   normal practice in C or any more modern language.  We have not tried
 193   to fix it because doing so would (a) be quite difficult, and (b)
 194   compromise forward-portability to other languages.
 195
 196 * Much of the code still assumes one-origin array indexing.  Thus,
 197   arrays are a cell larger than they strictly need to be and cell 0 is
 198   unused.
 199
 200 We have made exactly one minor architectural change.  In addition to the
 201 old code's per-object state-description messages, we now have a per-object
 202 message series for state *changes*.  This makes it possible to pull a fair
 203 amount of text out of the arbitrary-messages list and associate those
 204 messages with the objects that conceptually own them.
 205
 206 == Development status ==
 207
 208 We consider this project finished. All issues and TODOs have been
 209 cleared, behavior has been carefully checked against original ADVENT,
 210 no future demand for new features is expected, and the test suite has
 211 100% code coverage.  If new bugs appear the toolchain bit-rots out
 212 from under underneath, we will fix those problems.
 213
 214 // end