Documentation polishing. 142/head
authorJason S. Ninneman <jsn@mbar.us>
Tue, 27 Jun 2017 05:26:54 +0000 (22:26 -0700)
committerJason S. Ninneman <jsn@mbar.us>
Tue, 27 Jun 2017 05:27:44 +0000 (22:27 -0700)
adventure.yaml

index 53cb86c5041f16354081429477459df88a198105..29516625008065157a4c0e349f4d1f43e67465d7 100644 (file)
@@ -6,14 +6,17 @@
 #
 # We define a bunch of YAML structures:
 #
-# vocabulary: Almost all the words the game knows - one of them (the
+# vocabulary: - This structure is unused, and will eventually be removed. -
+#    Almost all the words the game knows - one of them (the
 #    reservoir magic word) gets replaced with a randomly-generated
 #    cookie.  For each word there is a type (motion, action, object,
 #    or special) and a numeric value.  Multiple synonyms may have the
 #    same value.
 #
-# actspk: Default message for action verbs.  The numbers correspond to
-#    values in the vocabulary list.
+# motions: Motion words, grouped into synonyms.
+#
+# actions: Action words, grouped into synonyms, and their corresponding
+#    default messages.
 #
 # hints: Each item contains a hint number, a hint label (used to
 #    generate the value macro for the hint) the number of turns he
 #    Order doesn't matter; the logic simply tests every threshold on
 #    the assumption that turn counts never decrease nor skip values.
 #
-# object_descriptions: Each item contains a description for use in the
+# objects: Each item contains a description for use in the
 #    inventory command and one or more messages describing the object
-#    in different states.  There is also a boolean "treasure"
-#    attribute, defaulting to false.  An pbject may have one or two
+#    in different states.  The vocabulary word(s) referring to this
+#    object are listed (words).  There is also a boolean "treasure"
+#    attribute, defaulting to false.  An object may have one or two
 #    start locations (the gate is an example of a two-location object;
 #    it can be accessed from above or below).  An object may also be
 #    flagged immovable, meaning it cannot be carried.  If a state
 #    message is a tuple then the first element is made the name of a
-#    #define viible to the code for the associayed state, numbered
-#    from zero upwards. If the inventory desription begins with "*"
+#    #define visble to the code for the associated state, numbered
+#    from zero upwards. If the inventory description begins with "*"
 #    the object is dungeon furniture that cannot be taken or carried.
 #
 # obituaries: Death messages and reincarnation queries.  Order is