Updated documentation.

mcantelon · Feb 5, 2011 · e4bb715 · e4bb715
1 parent fe51269
commit e4bb715
Show file tree

Hide file tree

Showing 23 changed files with 115 additions and 228 deletions.
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/fine_tuning.doctree b/doc/build/doctrees/fine_tuning.doctree
diff --git a/doc/build/doctrees/introduction.doctree b/doc/build/doctrees/introduction.doctree
diff --git a/doc/build/doctrees/manipulation.doctree b/doc/build/doctrees/manipulation.doctree
diff --git a/doc/build/doctrees/overview.doctree b/doc/build/doctrees/overview.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: c87b51632b76db3848230215656b7a02
+config: fd384d2931600e60d3e3b86be657dcb5
 tags: fbb0d17656682115ca4d033fb2f83ba1
diff --git a/doc/build/html/_sources/introduction.txt b/doc/build/html/_sources/introduction.txt
@@ -3,7 +3,7 @@ Introduction
 
 Fashion Quest is an interactive fiction framework created to make `text adventure games`_ about fashion because we love fashion and we love text adventure games. Fashion Quest is written in the Ruby programming language and requires Shoes_, a cross-platform GUI framework created by `Why the Lucky Stiff`_. Fashion Quest has been tested with Shoes 2.
 
-Games are created in Fashion Quest by defining game elements using YAML and bits of Ruby. The framework includes three demonstration games. The game "Fashion Quest: Daydream" is very small and designed to demonstrate non-player character features. It lives in the `game` directory. The game "Pirate Adventure Knockoff" is a port of the 1978 text adventure `"Pirate Adventure"`_ by Scott and Alexis Adams and lives in the `pirate_adventure` directory. The game `"Cloak of Darkness"`_ is a port of a game that was created as a means of comparing different interaction fiction frameworks. It lives in the `cloak_of_darkness` directory. There is also a game skeleton exists primarily to serve as the basis of new games. It lives in the `new_game` directory. 
+Games are created in Fashion Quest by defining game elements using YAML and bits of Ruby. The framework includes three demonstration games. The game "Fashion Quest: Daydream" is very small and designed to demonstrate non-player character features. It lives in the `daydream` directory. The game "Pirate Adventure Knockoff" is a port of the 1978 text adventure `"Pirate Adventure"`_ by Scott and Alexis Adams and lives in the `pirate_adventure` directory. The game `"Cloak of Darkness"`_ is a port of a game that was created as a means of comparing different interaction fiction frameworks. It lives in the `cloak_of_darkness` directory. There is also a game skeleton exists primarily to serve as the basis of new games. It lives in the `new_game` directory. 
 
 To play either of these use Shoes to run `run.rb` and select which you’d like to play.
 

diff --git a/doc/build/html/_sources/overview.txt b/doc/build/html/_sources/overview.txt
@@ -26,6 +26,8 @@ The `framework directory` is the directory containing `run.rb`. Its file structu
      - Directory containing developer documentation
    * - engine
      - Directory containing framework engine logic
+   * - games
+     - Directory containing games
    * - standard_commands
      - Directory containing standard game command definitions that can be shared between games
 

diff --git a/doc/build/html/elements.html b/doc/build/html/elements.html
@@ -7,13 +7,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Game World Elements &mdash; Fashion Quest v1.0 Alpha documentation</title>
+    <title>Game World Elements &mdash; Fashion Quest v1.0 Alpha 2 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',
+        VERSION:     '1.0 Alpha 2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -22,7 +22,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 v1.0 Alpha documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest v1.0 Alpha 2 documentation" href="index.html" />
     <link rel="next" title="Game World Manipulation" href="manipulation.html" />
     <link rel="prev" title="Overview" href="overview.html" /> 
   </head>
@@ -39,7 +39,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -460,7 +460,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="overview.html" title="Overview"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 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
@@ -7,13 +7,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Fine-Tuning &mdash; Fashion Quest v1.0 Alpha documentation</title>
+    <title>Fine-Tuning &mdash; Fashion Quest v1.0 Alpha 2 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',
+        VERSION:     '1.0 Alpha 2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -22,7 +22,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 v1.0 Alpha documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest v1.0 Alpha 2 documentation" href="index.html" />
     <link rel="prev" title="Game World Manipulation" href="manipulation.html" /> 
   </head>
   <body>
@@ -35,7 +35,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -157,15 +157,6 @@ <h2>Parsing<a class="headerlink" href="#parsing" title="Permalink to this headli
 <h3>Abbreviated Commands<a class="headerlink" href="#abbreviated-commands" title="Permalink to this headline">¶</a></h3>
 <p>Abbreviated commands reduce the amount of typing the user must do. One popular convention in interactive fiction is allowing a user simply to enter the first letter of the direction (s)he&#8217;d like to go in: <cite>n</cite> for <cite>go north</cite>, for example.</p>
 <p>The <cite>command_abbreviations.yaml</cite> file, in the <cite>parsing</cite> subdirectory of each game&#8217;s directory, allows a list of abbreviations for specific command instances to be defined using YAML. An example is shown below.</p>
-<div class="highlight-python"><pre>---
-n: "go north"
-s: "go south"
-e: "go east"
-w: "go west"
-u: "go up"
-d: "go down"
-</pre>
-</div>
 <p>Command abbreviations can alternatively be specified in <cite>config.yaml</cite>. An example is shown below.</p>
 <div class="highlight-python"><pre>command_abbreviations:
   n: "go north"
@@ -186,11 +177,6 @@ <h3>Synonyms<a class="headerlink" href="#synonyms" title="Permalink to this head
 <p>Synonyms help reduce the number of command syntax forms needed to support command syntax variations. The <cite>global_synonyms.yaml</cite> file, in the game <cite>parsing</cite> subdirectory of each game&#8217;s directory, can contain a list of word substitutions defined using YAML. These substitutions get applied to a user&#8217;s command input.</p>
 <p>For example, the word &#8220;using&#8221; can be replaced with the word &#8220;with&#8221;. This synonym would make the command syntax form &#8220;attack &lt;character&gt; with &lt;prop&gt;&#8221; work when the player enters the command &#8220;attack bear using hat&#8221;.</p>
 <p>Example YAML is shown below.</p>
-<div class="highlight-python"><pre>---
-using: "with"
-examine: "look"
-</pre>
-</div>
 <p>Synonyms can alternatively be specified in <cite>config.yaml</cite>. An example is shown below.</p>
 <div class="highlight-python"><pre>global_synonyms:
   using: "with"
@@ -202,13 +188,6 @@ <h3>Synonyms<a class="headerlink" href="#synonyms" title="Permalink to this head
 <h3>Garbage Words<a class="headerlink" href="#garbage-words" title="Permalink to this headline">¶</a></h3>
 <p>Garbage words are words with little or no semantic meaning (like &#8220;the&#8221; and &#8220;a). By removing them from the user&#8217;s command input we recude the number of command syntax forms needed to support command syntax variations. The <cite>garbage_words.yaml</cite> file, found in the <cite>parsing</cite> subdirectory of each game&#8217;s directory, can contain a list of words that should be discarded from player input.</p>
 <p>Example YAML is shown below.</p>
-<div class="highlight-python"><pre>---
-- "the"
-- "that"
-- "this"
-- "at"
-</pre>
-</div>
 <p>Garbage words can alternatively be specified in <cite>config.yaml</cite>. An example is shown below.</p>
 <div class="highlight-python"><pre>garbage_words:
 - "the"
@@ -254,7 +233,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
@@ -7,13 +7,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Index &mdash; Fashion Quest v1.0 Alpha documentation</title>
+    <title>Index &mdash; Fashion Quest v1.0 Alpha 2 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',
+        VERSION:     '1.0 Alpha 2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -22,7 +22,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 v1.0 Alpha documentation" href="index.html" /> 
+    <link rel="top" title="Fashion Quest v1.0 Alpha 2 documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -31,7 +31,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -79,7 +79,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/index.html b/doc/build/html/index.html
@@ -7,13 +7,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Fashion Quest &mdash; Fashion Quest v1.0 Alpha documentation</title>
+    <title>Fashion Quest &mdash; Fashion Quest v1.0 Alpha 2 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',
+        VERSION:     '1.0 Alpha 2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -22,7 +22,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 v1.0 Alpha documentation" href="#" />
+    <link rel="top" title="Fashion Quest v1.0 Alpha 2 documentation" href="#" />
     <link rel="next" title="Introduction" href="introduction.html" /> 
   </head>
   <body>
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              accesskey="N">next</a> |</li>
-        <li><a href="#">Fashion Quest v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="#">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -124,7 +124,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="introduction.html" title="Introduction"
              >next</a> |</li>
-        <li><a href="#">Fashion Quest v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="#">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/doc/build/html/introduction.html b/doc/build/html/introduction.html
@@ -7,13 +7,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Introduction &mdash; Fashion Quest v1.0 Alpha documentation</title>
+    <title>Introduction &mdash; Fashion Quest v1.0 Alpha 2 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',
+        VERSION:     '1.0 Alpha 2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -22,7 +22,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 v1.0 Alpha documentation" href="index.html" />
+    <link rel="top" title="Fashion Quest v1.0 Alpha 2 documentation" href="index.html" />
     <link rel="next" title="Overview" href="overview.html" />
     <link rel="prev" title="Fashion Quest" href="index.html" /> 
   </head>
@@ -39,7 +39,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 v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar">
@@ -88,7 +88,7 @@ <h3>Quick search</h3>
   <div class="section" id="introduction">
 <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
 <p>Fashion Quest is an interactive fiction framework created to make <a class="reference external" href="http://en.wikipedia.org/wiki/Interactive_fiction">text adventure games</a> about fashion because we love fashion and we love text adventure games. Fashion Quest is written in the Ruby programming language and requires <a class="reference external" href="http://shoes.heroku.com/">Shoes</a>, a cross-platform GUI framework created by <a class="reference external" href="http://en.wikipedia.org/wiki/Why_the_lucky_stiff/">Why the Lucky Stiff</a>. Fashion Quest has been tested with Shoes 2.</p>
-<p>Games are created in Fashion Quest by defining game elements using YAML and bits of Ruby. The framework includes three demonstration games. The game &#8220;Fashion Quest: Daydream&#8221; is very small and designed to demonstrate non-player character features. It lives in the <cite>game</cite> directory. The game &#8220;Pirate Adventure Knockoff&#8221; is a port of the 1978 text adventure <a class="reference external" href="http://en.wikipedia.org/wiki/Pirate_Adventure">&#8220;Pirate Adventure&#8221;</a> by Scott and Alexis Adams and lives in the <cite>pirate_adventure</cite> directory. The game <a class="reference external" href="http://www.firthworks.com/roger/cloak/">&#8220;Cloak of Darkness&#8221;</a> is a port of a game that was created as a means of comparing different interaction fiction frameworks. It lives in the <cite>cloak_of_darkness</cite> directory. There is also a game skeleton exists primarily to serve as the basis of new games. It lives in the <cite>new_game</cite> directory.</p>
+<p>Games are created in Fashion Quest by defining game elements using YAML and bits of Ruby. The framework includes three demonstration games. The game &#8220;Fashion Quest: Daydream&#8221; is very small and designed to demonstrate non-player character features. It lives in the <cite>daydream</cite> directory. The game &#8220;Pirate Adventure Knockoff&#8221; is a port of the 1978 text adventure <a class="reference external" href="http://en.wikipedia.org/wiki/Pirate_Adventure">&#8220;Pirate Adventure&#8221;</a> by Scott and Alexis Adams and lives in the <cite>pirate_adventure</cite> directory. The game <a class="reference external" href="http://www.firthworks.com/roger/cloak/">&#8220;Cloak of Darkness&#8221;</a> is a port of a game that was created as a means of comparing different interaction fiction frameworks. It lives in the <cite>cloak_of_darkness</cite> directory. There is also a game skeleton exists primarily to serve as the basis of new games. It lives in the <cite>new_game</cite> directory.</p>
 <p>To play either of these use Shoes to run <cite>run.rb</cite> and select which you’d like to play.</p>
 <p>Thanks to Why the Lucky Stiff for creating Shoes and inspiring the creative use of computers!</p>
 <div class="section" id="why-use-a-framework">
@@ -139,7 +139,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Fashion Quest"
              >previous</a> |</li>
-        <li><a href="index.html">Fashion Quest v1.0 Alpha documentation</a> &raquo;</li> 
+        <li><a href="index.html">Fashion Quest v1.0 Alpha 2 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">