archives/open-adventure
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation polishing.

Browse source
This commit is contained in:
Eric S. Raymond 2017-07-02 11:01:32 -04:00
parent 1d41d9a2f8
commit ea963d4af8
1 changed files with 18 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

31
notes.adoc
View file

@ -29,15 +29,16 @@ with the BSD Games version.
== Philosophy == == Philosophy ==
Extreme care has been taken not to make changes that would alter the Extreme care has been taken not to make changes that would alter the
logic of the game as we received it from Don Woods. By policy, all logic of the game as we received it from Don Woods, except to fix
user-visible changes must be revertible with the -o (oldstyle) option. glitches that were clearly bugs. By policy, all user-visible
changes must be revertible with the -o (oldstyle) option.
It is a goal of this project to exactly preserve the *behavior* of It is a goal of this project to exactly preserve the *intended
430-point Adventure, but the implementation of it is fair game for behavior* of 430-point Adventure, but the implementation of it is fair
improvement. In particular, we are concerned to move it to a form that game for improvement. In particular, we are concerned to move it to a
is (a) readable, and (b) friendly to forward translation to future form that is (a) readable, and (b) friendly to forward translation to
languages. It has already survived a move from FORTRAN to C; a future future languages. It has already survived a move from FORTRAN to C; a
as a Python or Go translation seems possible, even probable. future as a Python or Go translation seems possible, even probable.
== Functional changes == == Functional changes ==
@ -90,10 +91,14 @@ with coverage tools (we now have over 95% coverage, with the remaining
confined to exception cases that are very difficult to reach). This is confined to exception cases that are very difficult to reach). This is
what you are running when you do "make check". what you are running when you do "make check".
In the process we found and fixed a few minor bugs. Most notably, reading In the process we found and fixed a few minor bugs:
the relocated Witt's End sign in the endgame didn't work. Behavior when
saying the giant's magic words outside his room wasn't quite right either. * Reading the relocated Witt's End sign in the endgame didn't work.
Attempt to extinguish dark urn would have cause it do lose oil.
* Behavior when saying the giant's magic words outside his room wasn't
quite right - the game responded as though the player were in the room.
* Attempting to extinguish an unlit urn caused it to lose its oil.
The move to modern C entailed some structural changes. The most The move to modern C entailed some structural changes. The most
important was the refactoring of over 350 gotos into if/loop/break important was the refactoring of over 350 gotos into if/loop/break
@ -149,7 +154,7 @@ ways:
We have made exactly one minor architectural change. In addition to the We have made exactly one minor architectural change. In addition to the
old code's per-object state-description messages, we now have a per-object old code's per-object state-description messages, we now have a per-object
message series for state *changes*. This makes it possible to pull a fair message series for state *changes*. This makes it possible to pull a fair
amount of test out of the arbitrary-messages list and associate those amount of text out of the arbitrary-messages list and associate those
mesages with the objects that conceptually own them. mesages with the objects that conceptually own them.
// end // end