Add readme

icheered · Mar 15, 2023 · cd68b90 · cd68b90
1 parent b49313d
commit cd68b90
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Text based adventure
+One approach to a text based adventure. The story has been separated in a separate file as to not mix code and story.
+
+Check out story.txt for an example of the syntax.
+- +variablename[Text to print] - Ask for user input and store it in variablename
+- {variablename} - Print the value of variablename
+- [storyblock] - Start a storyblock
+- @storyblock - Jump to a storyblock
+    - If there are multiple jumps, the user is shown a prompt where they can choose which storyblock to jump to. The syntax is @storyblock[Text to print](valid user options)
+
+The first storyblock must be called 'start' and the final storyblock must be called 'end'.
diff --git a/story.txt b/story.txt
@@ -5,7 +5,6 @@ What is your name?
 Hello {username}!
 
 Do you want to pick up the item?
-;
 @itempickup[Pick up](yes y)
 @itemnotpickup[Don't pick up](no n)