Added readme

1 files changed, 47 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..e063e3e
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,47 @@
+
+Hunt The Wumpus
+
+
+
+An implementation of the classic text adventure game.
+
+You are trapped in a cave, and must kill the deadly wumpus. However, should you
+enter the same room as the wumpus, it will eat you before you can move. So the
+game revolves around deducing which room the wumpus is in, and then shooting it
+from the next room over. Note that if you guess incorrectly, the wumpus will be
+startled and will move from where it is to a random adjacent room.
+
+
+If the wumpus is in a room directly connected to the current one, you will
+perceive a stench.
+
+If your current room is covered in bat guano, that is a sign that a connecting
+room contains a giant bat that will transport you to a different random room in
+the cave.
+
+Feeling a breeze indicates that a connecting room contains a bottomless pit, which
+is of course, quite deadly.
+
+Seeing a glitter indicates that there is gold to be found where you are. GOLD! You
+may then take the gold. It's a bonus.
+
+
+Valid commands:
+look
+move <direction>
+go <direction>
+<direction>
+shoot <direction>
+take gold
+exit
+quit
+
+All of these should be fairly self explanatory. Look can be abbreviated as l, and
+directions can be abbreviated using standard compass notation.
+
+
+This version of Hunt The Wumpus was implemented in SWI-Prolog, and compiling,
+interpreting, or otherwise playing it requires prolog to be installed. Preferably
+SWI-Prolog, as an audit regarding SWI-exclusive built in predicates has yet to be
+conducted.
+