changeset 594:67f0b8123854

Walkthrough
author Stefano Rivera <stefano@rivera.za.net>
date Sun, 10 Apr 2011 19:36:15 +0200
parents 75e955c11154
children 74efd0a9c959
files docs/Makefile docs/conf.py docs/images/celestial_plane.png docs/images/fishmonger_house.png docs/images/geisha_room.png docs/images/market.png docs/images/road.png docs/images/tea_house.png docs/images/temple.png docs/images/temple_grounds.png docs/images/theatre.png docs/images/town.png docs/index.rst docs/walkthrough.rst
diffstat 14 files changed, 544 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Makefile	Sun Apr 10 19:36:15 2011 +0200
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NineTales.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NineTales.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/NineTales"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NineTales"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/conf.py	Sun Apr 10 19:36:15 2011 +0200
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Nine Tales documentation build configuration file, created by
+# sphinx-quickstart on Sun Apr 10 18:08:03 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.todo']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Nine Tales'
+copyright = u'2011, Adrianna PiƄska, Anna Malczyk, Jeremy Thurgood, Neil Muller, Oliver Hambsch, Simon Cross, Stefano Rivera'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'NineTalesdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'NineTales.tex', u'Nine Tales Documentation',
+   u'Adrianna Pinska, Anna Malczyk, Jeremy Thurgood, Neil Muller, Oliver Hambsch, Simon Cross, Stefano Rivera', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'ninetales', u'Nine Tales Documentation',
+     [u'Adrianna Pinska, Anna Malczyk, Jeremy Thurgood, Neil Muller, Oliver Hambsch, Simon Cross, Stefano Rivera'], 1)
+]
Binary file docs/images/celestial_plane.png has changed
Binary file docs/images/fishmonger_house.png has changed
Binary file docs/images/geisha_room.png has changed
Binary file docs/images/market.png has changed
Binary file docs/images/road.png has changed
Binary file docs/images/tea_house.png has changed
Binary file docs/images/temple.png has changed
Binary file docs/images/temple_grounds.png has changed
Binary file docs/images/theatre.png has changed
Binary file docs/images/town.png has changed
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/index.rst	Sun Apr 10 19:36:15 2011 +0200
@@ -0,0 +1,22 @@
+.. Nine Tales documentation master file, created by
+   sphinx-quickstart on Sun Apr 10 18:08:03 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Nine Tales's documentation!
+======================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   walkthrough
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/walkthrough.rst	Sun Apr 10 19:36:15 2011 +0200
@@ -0,0 +1,176 @@
+Nine Tales Walkthrough
+======================
+
+.. _temple:
+
+The Temple
+----------
+
+.. image:: images/temple.png
+   :scale: 20%
+
+Connects to :ref:`the Temple Grounds <temple_grounds>`.
+
+#. The monk wants a cup of tea.
+#. Put the tea leaves in the tea pot.
+#. Pour some tea into the tea cup.
+#. Hand it to the monk, and collect your shape-shifting tail.
+
+.. _temple_grounds:
+
+The Temple Grounds
+------------------
+
+.. image:: images/temple_grounds.png
+   :scale: 20%
+
+Connects :ref:`the Temple <temple>` to :ref:`the Road <road>`.
+
+#. The guard won't let foxes past.
+#. But he might be tempted by a pretty geisha.
+#. Assuming she's holding a fan (found in :ref:`the Temple <temple>`)
+#. Flutter your fan at the guard, and collect your fireball tail.
+
+.. _road:
+
+The Road
+--------
+
+.. image:: images/road.png
+   :scale: 14%
+
+Connects :ref:`the Temple Grounds <temple_grounds>` to :ref:`the Town
+<town>`.
+
+#. Hattori and Ichiro are waiting for the signal fire to be lit.
+#. There is kindling in the bamboo above them.
+#. There is oil in a pot below the signal fire.
+#. Put both on the fire.
+#. The Samurai will now notice the fire, if you talk to them.
+#. Collect your sprinting tail.
+
+1. Sasuke doesn't like his cannon very much.
+#. You can destroy it with fire.
+#. Talk to Sasuke, he'll see the broken cannon and run away.
+#. Collect your invisibility tail.
+
+.. _town:
+
+The Town
+--------
+
+.. image:: images/town.png
+   :scale: 14%
+
+Connects (from left to right) to:
+
+*  :ref:`the Road <road>`,
+*  :ref:`the Theatre <theatre>`,
+*  :ref:`the Tea House <tea_house>`,
+*  :ref:`the Market <market>`, and
+*  :ref:`the Celestial Plane <celestial_plane>`.
+
+Until you can fly, the easiest way is up the left hand side and across
+the top.
+
+You can't enter :ref:`the Celestial Plane <celestial_plane>` until you
+have all the tails.
+
+.. _theatre:
+
+The Theatre
+-----------
+
+.. image:: images/theatre.png
+   :scale: 20%
+
+Connects to :ref:`the Town <town>`.
+
+#. The actor won't talk to you as long as he's guarding the mask and the
+   costume.
+#. The mask can be damaged.
+#. The costume can be hidden.
+#. When he sees his failure, you can collect the lightning-bolt attack
+   tail.
+
+.. _tea_house:
+
+The Tea House
+-------------
+
+.. image:: images/tea_house.png
+   :scale: 20%
+
+Connects :ref:`the Town <town>` to :ref:`the Geisha's Room
+<geisha_room>`.
+
+#. Tetsuo and Kaneda look like they'll come to agreement. If the deal
+   was more one-sided, maybe they won't.
+#. You can alter their contract.
+#. You can destroy the bag of rice.
+#. They'll argue and you collect your life-stealing tail.
+
+.. _geisha_room:
+
+The Geisha's Room
+-----------------
+
+.. image:: images/geisha_room.png
+   :scale: 20%
+
+Connects to :ref:`the Tea House <tea_house>`.
+
+#. Kumiko lives in a perfect world.
+#. You can tear her kimono.
+#. You can destroy her vase.
+#. You can put something smelly in her room.
+#. You can get a fish from :ref:`the Fishmonger's House
+   <fishmonger_house>`.
+#. When Kaneda sees her distress, he'll leave, and you'll get your
+   flying tail.
+
+.. _market:
+
+The Market
+----------
+
+.. image:: images/market.png
+   :scale: 14%
+
+Connects :ref:`the Town <town>` to :ref:`the Fishmonger's House
+<fishmonger_house>`.
+
+#. Maneki tells you about the Fishmonger who's under attack.
+#. You're pretty good at killing demons by now.
+#. Head to :ref:`the Fishmonger's House <fishmonger_house>` and rescue
+   him.
+#. Maneki will reward you with your shield tail.
+
+.. _fishmonger_house:
+
+The Fishmonger's House
+----------------------
+
+.. image:: images/fishmonger_house.png
+   :scale: 20%
+
+Connects to :ref:`the Market <market>`.
+
+#. The Fishmonger needs some demons to be killed.
+#. Rescue him, and he'll give you a nice fresh fish.
+
+.. _celestial_plane:
+
+The Celestial Plane:
+--------------------
+
+.. image:: images/celestial_plane.png
+   :scale: 20%
+
+Connects to :ref:`the Town <town>`.
+Requires all 9 tails to enter.
+
+#. The Evil Kitsune doesn't seem to want to fight.
+#. But if you have found a haiku scroll you can challenge him to a haiku
+   competition.
+#. With all 5 scrolls, it should be easy.