Updated doc built.

mcantelon · Mar 1, 2014 · 9f6cdd9 · 9f6cdd9
1 parent 2064a56
commit 9f6cdd9
Show file tree

Hide file tree

Showing 14 changed files with 82 additions and 44 deletions.
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/manipulation.doctree b/doc/build/doctrees/manipulation.doctree
diff --git a/doc/build/html/.buildinfo b/doc/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d85ab96426e5a51c0b415fea69538416
+config: a2b96027907e42c550af4e5465196ea9
 tags: fbb0d17656682115ca4d033fb2f83ba1
diff --git a/doc/build/html/_sources/manipulation.txt b/doc/build/html/_sources/manipulation.txt
@@ -14,7 +14,7 @@ Each command is defined in its own YAML file within the 'commands' subdirectory
 
 The example below, from the "Pirate Adventure Knockoff" demonstration game, defines a command that enables the player to wake up the pirate character. If the character's `asleep` trait is `true` the `asleep` trait will be changed to `false` if the player enters the command `wake pirate`.
 
-.. literalinclude:: ../../pirate_adventure/commands/wake.yaml
+.. literalinclude:: ../../games/pirate_adventure/commands/wake.yaml
 
 Commands are made up of syntax and logic.
 
@@ -118,7 +118,7 @@ Events enable Ruby logic to be triggered by happenings in the game world. Charac
 
 For example, the `cat` character in the "Fashion Quest: Daydream" demonstration game responds to three events: `on_attack` (when the cat is attacked), `on_death` (when the cat is killed), and `on_pet` (when the player pets the cat).
 
-.. literalinclude:: ../../game/characters/cat.yaml
+.. literalinclude:: ../../games/daydream/characters/cat.yaml
 
 Commands can be used to trigger events. For example, the standard get command triggers the `on_get` event on a prop (and collects event output into the variable `on_get_output` by including the following line:
 

diff --git a/doc/build/html/elements.html b/doc/build/html/elements.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Game World Elements &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Game World Elements &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" />
     <link rel="next" title="Game World Manipulation" href="manipulation.html" />
     <link rel="prev" title="Overview" href="overview.html" /> 
   </head>
@@ -42,7 +42,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="overview.html" title="Overview"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -463,7 +463,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="overview.html" title="Overview"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/fine_tuning.html b/doc/build/html/fine_tuning.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Fine-Tuning &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Fine-Tuning &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" />
     <link rel="prev" title="Game World Manipulation" href="manipulation.html" /> 
   </head>
   <body>
@@ -38,7 +38,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="manipulation.html" title="Game World Manipulation"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -257,7 +257,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="manipulation.html" title="Game World Manipulation"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
@@ -10,15 +10,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Index &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Index &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,7 +27,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" /> 
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              accesskey="I">index</a></li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -84,7 +84,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              >index</a></li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/index.html b/doc/build/html/index.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Fashion Quest &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Fashion Quest &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="#" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="#" />
     <link rel="next" title="Introduction" href="introduction.html" /> 
   </head>
   <body>
@@ -38,7 +38,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              accesskey="N">next</a> |</li>
-        <li><a href="#">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="#">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -127,7 +127,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              >next</a> |</li>
-        <li><a href="#">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="#">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/introduction.html b/doc/build/html/introduction.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Introduction &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Introduction &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" />
     <link rel="next" title="Overview" href="overview.html" />
     <link rel="prev" title="Fashion Quest" href="index.html" /> 
   </head>
@@ -42,7 +42,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Fashion Quest"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -142,7 +142,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Fashion Quest"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/manipulation.html b/doc/build/html/manipulation.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Game World Manipulation &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Game World Manipulation &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" />
     <link rel="next" title="Fine-Tuning" href="fine_tuning.html" />
     <link rel="prev" title="Game World Elements" href="elements.html" /> 
   </head>
@@ -42,7 +42,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="elements.html" title="Game World Elements"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -112,6 +112,24 @@ <h2>Commands<a class="headerlink" href="#commands" title="Permalink to this head
 <p class="last">Symbolic links can also be used, instead of empty command files, to point to standard commands but Windows doesn&#8217;t support symbolic links so the game won&#8217;t be cross platform.</p>
 </div>
 <p>The example below, from the &#8220;Pirate Adventure Knockoff&#8221; demonstration game, defines a command that enables the player to wake up the pirate character. If the character&#8217;s <cite>asleep</cite> trait is <cite>true</cite> the <cite>asleep</cite> trait will be changed to <cite>false</cite> if the player enters the command <cite>wake pirate</cite>.</p>
+<div class="highlight-python"><pre>---
+syntax:
+- "wake &lt;character&gt;"
+- "wake up &lt;character&gt;"
+
+logic: |
+
+  output = ''
+
+  if character.traits['asleep'] == true
+    character.traits['asleep'] = false
+  else
+    output &lt;&lt; "You can't wake up what is not asleep.\n"
+  end
+
+  output
+</pre>
+</div>
 <p>Commands are made up of syntax and logic.</p>
 <p>TIP: Keep the idea of reusing commands between games in mind when creating commands. If logic is game-specific, try to use transitions instead of commands to implement the logic.</p>
 <div class="section" id="syntax-forms">
@@ -186,6 +204,26 @@ <h3>Conditions<a class="headerlink" href="#conditions" title="Permalink to this
 <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2>
 <p>Events enable Ruby logic to be triggered by happenings in the game world. Characters, props, and doors can all have event outcome associated with them.</p>
 <p>For example, the <cite>cat</cite> character in the &#8220;Fashion Quest: Daydream&#8221; demonstration game responds to three events: <cite>on_attack</cite> (when the cat is attacked), <cite>on_death</cite> (when the cat is killed), and <cite>on_pet</cite> (when the player pets the cat).</p>
+<div class="highlight-python"><pre>--- 
+cat: 
+  location: bedroom
+  mobility: 100
+  strength: 1
+  description: The cat is small and agile.
+  hp: 2
+  aggression: 5
+  default_attack: its claws
+  events:
+    on_attack:
+    - "The cat yowls as he leaps at you.\n"
+    on_death:
+    - "The cat shrieks as it crumples to the ground.\n"
+    on_pet:
+    - "The cat purrs and rolls around.\n"
+    - "The cat makes a strange cooing sound.\n"
+    - "The cat stretches and purrs.\n"
+</pre>
+</div>
 <p>Commands can be used to trigger events. For example, the standard get command triggers the <cite>on_get</cite> event on a prop (and collects event output into the variable <cite>on_get_output</cite> by including the following line:</p>
 <div class="highlight-ruby"><div class="highlight"><pre><span class="n">on_get_output</span> <span class="o">=</span> <span class="vi">@game</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="s1">&#39;on_get&#39;</span><span class="p">)</span>
 </pre></div>
@@ -257,7 +295,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="elements.html" title="Game World Elements"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv
diff --git a/doc/build/html/overview.html b/doc/build/html/overview.html
@@ -8,15 +8,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Overview &mdash; Fashion Quest 1.0 Alpha 2 documentation</title>
+    <title>Overview &mdash; Fashion Quest 1.0 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '1.0 Alpha 2',
+        VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Fashion Quest 1.0 Alpha 2 documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest 1.0 documentation" href="index.html" />
     <link rel="next" title="Game World Elements" href="elements.html" />
     <link rel="prev" title="Introduction" href="introduction.html" /> 
   </head>
@@ -42,7 +42,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -197,7 +197,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest 1.0 Alpha 2 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest 1.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">