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-06-23 11:27:20 -04:00
parent 1e8c3a4a1d
commit 6bd1c356e2
1 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

20
adventure.yaml
View file

@ -14,9 +14,11 @@
# number of the hint. These values are stashed in the "hints" # number of the hint. These values are stashed in the "hints"
# array. # array.
# #
# locations: Each item contains a long and short description. Some # locations: They have attributes as follows...
# short descriptions are empty. Order of these locations is not significant. #
# Location conditions can be read as follows: # long: Long description, always shown on first encounter.
# short: Short description. If none, use long description.
# conditions: A dictionary of attributes
# LIT Light # LIT Light
# OILY If FLUID flag is on: true for oil, false for water # OILY If FLUID flag is on: true for oil, false for water
# FLUID Liquid asset # FLUID Liquid asset
@ -32,11 +34,13 @@
# HWOODS Lost in forest # HWOODS Lost in forest
# HOGRE Trying to deal with ogre # HOGRE Trying to deal with ogre
# HJADE Found all treasures except jade # HJADE Found all treasures except jade
# The optional hints field is a list of YAML references to hints # hints: A list of YAML references to hints that may be available at
# that may be available at this location. (This is why locations # this location. (This is why locations has to follow hints.)
# has to follow hints.) The "sound" attribute, if present, is s # sound: Label for a location sound.
# label for a location sound. If there is a "loud" attribute and # loud: If true, object sounds are drowned out at this location.
# it is true, object sounds are drowned out at this location. #
# All attributes are optional except the long description. Order of
# locations is not significant.
# #
# 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 (for now). # these messages need to be kept adjacent and ordered (for now).