summaryrefslogtreecommitdiff
path: root/stage.txt
diff options
context:
space:
mode:
Diffstat (limited to 'stage.txt')
-rw-r--r--stage.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/stage.txt b/stage.txt
new file mode 100644
index 0000000..751b1f0
--- /dev/null
+++ b/stage.txt
@@ -0,0 +1,29 @@
1Simple, Textual, Adventure Game Environemnt
2===========================================
3
4This is a program that loads games from files that use the Stage language to
5describe a complete adventure game. There are lots and lots of possibilities.
6
7This documentation is primarily aimed at game developers initially.
8
9Structure
10=========
11
12A game is divided into several pieces. At any point during the play of a game
13a player will be "in" a situation. Each situation provides context for the
14player. They can be thought of like rooms in a MUD game or locations in an old
15text adventure title, but are more flexible, as they allow different possible
16transitions between them as well as different contexts for commands.
17
18Each situation is effectively a block of code that is run when the situation is
19made active. I.e. that code runs when the player enters a room, say. Every
20time a situation starts it contains an empty context, but may have access to
21global parameters.
22
23Variables may be set and used, and there are some special variables that you
24have access to that control the way the system works and interactions with the
25player.
26
27New functions can be defined that can be used from any code.
28
29