summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-01-07 20:50:07 +0000
committerThomas Kluyver <takowl@gmail.com>2013-01-07 20:50:07 +0000
commit3400844980917bb3d59da322a3e33f55f81afe12 (patch)
tree898ff62681401e2c0a4b4a66c11f626d7b784a25 /doc
parent87e6fd0a9d0ec7869dc9e6e404638cc1e090e3a7 (diff)
Add a simple way to test tiles
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst1
-rw-r--r--doc/testing.rst13
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 61d7ed2..c4184d5 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -21,6 +21,7 @@ The idea is that anything goes, but we do need a few house rules:
interface.rst
api_misc.rst
+ testing.rst
If you prefer to learn by example, have a look at the `tiles already in the game
<https://github.com/takluyver/weatbag/tree/master/weatbag/tiles>`_.
diff --git a/doc/testing.rst b/doc/testing.rst
new file mode 100644
index 0000000..db70f09
--- /dev/null
+++ b/doc/testing.rst
@@ -0,0 +1,13 @@
+Testing tiles
+=============
+
+To save you repeatedly playing through the game to test your latest changes,
+there's a script to skip to any given tile::
+
+ ./test_tile.py n2
+
+If the player needs specific items to test the tile, add a list called test_items
+to the module. The test script will add these to the player's inventory. For
+example, tile n2 defines::
+
+ test_items = ['unlit torch']