34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Interactive Storys
|
|
This program lets you play interactive stories using a custom syntax, I might add more syntax's at some point, but I think the program is mostly for personal use and I like the simplicity of this syntax so yeah.
|
|
|
|
# Syntax
|
|
## Rules
|
|
- Each line of narrative will begin with a number or group of characters that are the identifier of that line.
|
|
- The end of each line will end in curly braces with one or more identifiers within it, these are the refrenced lines.
|
|
- If there are more than one reference in a line, that means there is a decision and the user will be prompted to chose one of the options
|
|
- If there is only one reference, the program will go straight into that peice of narrative
|
|
- Any line that doesn't begin with a number or letter will be ignored, and thus can be treated as a comment
|
|
- The first index always begins at "0"
|
|
- The order of lines in the syntax does not matter
|
|
- If the reference is "exit" then the program will quit
|
|
## Examples
|
|
```
|
|
# Story Telling
|
|
0 You walk down the road {A,B}
|
|
1 You walk around the park and return to the road {0}
|
|
2 You are now in the shop the end {exit}
|
|
|
|
# Choices
|
|
A Go to the park {1}
|
|
B Go to the shop {2}
|
|
```
|
|
|
|
# Usage
|
|
Pass a story file as a paramter:
|
|
```interactive-storys example.story```
|
|
Help:
|
|
```interactive-storys help```
|
|
|
|
# License
|
|
GPL-3.0
|