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

Fixups to the adventure.yaml commentary.

Browse source
This commit is contained in:
Jason S. Ninneman 2017-06-22 10:20:42 -07:00 • committed by Eric S. Raymond
parent e4b2877733
commit 3215930f64
1 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

20
adventure.yaml
View file

@ -1,4 +1,4 @@
# This YAML file gets processed into a collection of data structure and # This YAML file gets processed into a collection of data structures and
# variable initializers describing Colossal Cave. It replaces an ad-hoc # variable initializers describing Colossal Cave. It replaces an ad-hoc
# text database shipped with Adventure versions up to 2.5. The format # text database shipped with Adventure versions up to 2.5. The format
# change enabled a lot of use of symbolic names where there were previously # change enabled a lot of use of symbolic names where there were previously
@ -26,12 +26,14 @@
# HOGRE Trying to deal with ogre # HOGRE Trying to deal with ogre
# HJADE Found all treasures except jade # HJADE Found all treasures except jade
# #
# arbitrary_messages: These are arguments to RSPEAK(). Some spans of # arbitrary_messages: These are arguments to rspeak(). Some spans of
# these messages need to be kept adjacent and ordered. To see which, # these messages need to be kept adjacent and ordered (for now).
# grep for RSPEAK calls containing expressions with arithmetic. # To see which, grep for rspeak() calls containing expressions with
# arithmetic. Eventually, these will be pulled out into more appropriate
# data structures. Then ordering can be dropped, and gaps removed.
# #
# classes: Each item contains a point threshold and a message # classes: Each item contains a point threshold and a message
# describing a classification of player. point thresholds must be # describing a classification of player. Point thresholds must be
# in ascending order. The scoring code selects the appropriate # in ascending order. The scoring code selects the appropriate
# message, where each message is considered to apply to players # message, where each message is considered to apply to players
# whose scores are higher than the previous N but not higher than # whose scores are higher than the previous N but not higher than
@ -39,10 +41,10 @@
# modification (and particularly expansion) of the program. # modification (and particularly expansion) of the program.
# #
# turn_thresholds: Each item contains a number and a message # turn_thresholds: Each item contains a number and a message
# berating the player for taking so many turns. The messages must # berating the player for taking so many turns. When the turn count
# be in the proper (ascending) order. The message gets printed if # matches one of the thresholds, the corresponding message is shown.
# the player exceeds N % 100000 turns, at which time N/100000 # Order doesn't matter; the logic simply tests every threshold on
# points get deducted from his score. # the assumption that turn counts never decrease nor skip values.
# #
# objects: Each item contains a description for use in the inventory command # objects: Each item contains a description for use in the inventory command
# and one or more messages describing the object in different states. # and one or more messages describing the object in different states.