Some documentation for the abyss bot.

1 files changed, 17 insertions, 0 deletions

diff --git a/crawl-ref/source/test/stress/abyss b/crawl-ref/source/test/stress/abyss
index 56e99f3e73..66e0465dca 100755
--- a/crawl-ref/source/test/stress/abyss
+++ b/crawl-ref/source/test/stress/abyss
@@ -2,6 +2,23 @@
 
 # Usage: test/stress/abyss game_id, where game_id must be a number.  If not
 # provided, it defaults to the script's PID.
+#
+# After starting, it's good to customize the instance somewhat, especially
+# the race.  Nagas and octopodes are prime choices because of constriction.
+#
+# You can learn spells via &^M (when there are no monsters on the screen,
+# if you adjust the spell via =s to an uppercase letter, the bot will randomly
+# cast it from time to time.  If more than one spell uses a capital letter,
+# one will be picked at random.  Sadly, this works only for spells that don't
+# require a target.
+
+# When a crash happens:
+# * backup the save just to be safe
+# * ensure you have the same terminal size
+# * re-run test/stress/abyss specifying the same number.  If you didn't
+#   provide one initially, it is given in the save's name.
+# * if all went well, you will see the exact same crash
+# * debug it!
 
 GAME=${1:-$$}