New notes.adoc file; major documentation update.

This commit is contained in:
Eric S. Raymond 2017-06-12 22:02:32 -04:00
parent bc1dd279e2
commit 1b167e5e72
4 changed files with 137 additions and 49 deletions

View file

@ -135,51 +135,6 @@ museumization after historians rediscovered Yob's game.)
Neither of these games used an attempt at a natural-language parser
even as primitive as Adventure's.
== Nomenclature ==
This project is called "Open Adventure" because it's not at all clear
to number Adventure past 2.5 without misleading or causing
collisions. Various of the non-mainline versions have claimed to be
versions 3, 4, 5, 6, 7 and for all I know higher than that. It seems
best just to start a new numbering series while acknowledging the
links back.
We have reverted to "advent" for the binary to avoid a name collision
with the BSD Games version.
== Functional changes in Open Adventure ==
By default, advent issues "> " as a command prompt. This feature
became common in many variants after the original 350-point version,
but was never backported into Crowther & Woods's main line before now.
The "-o" (oldstyle) version reverts the behavior.
A "seed" command has been added. This is not intended for human use
but as a way for game logs to set the PRNG (pseudorandom-number generator) so
that random events (dwarf & pirate appearances, the bird's magic word)
will be reproducible.
A -l command-line option has been added. When this is given (with a
file path argument) each command entered will be logged to the
specified file. Additionally, a generated "seed" command will be put
early in the file capturing the randomized start state of the PRNG
so that replays of the log will be reproducible.
Using "seed" and -l, the distribution now includes a regression-test
suite for the game. Any log captured with -l (and thus containing
a "seed" command) will replay reliably, including random events.
The adventure.text file is no longer required at runtime. Instead, it
is compiled at build time to a source module containing C structures,
which is then linked to the advent binary.
The game-save format has changed. This was done to simplify
FORTRAN-derived code that formerly implemented these functions;
without C's fread(3)/fwrite() and structs it was necessarily pretty
ugly by modern stabdards. Encryption and checksumming have been
discarded - it's pointless to try tamper-prooing saves when everyone
has the source code.
== Sources ==
[bibliography]