92 lines
961 B
Markdown
92 lines
961 B
Markdown
# Syntax
|
|
|
|
## Setup
|
|
|
|
This is done in the about.json file,
|
|
|
|
```
|
|
{
|
|
|
|
"title": "My Great Story",
|
|
|
|
"description": "please read!"
|
|
|
|
}
|
|
```
|
|
|
|
## Characters
|
|
|
|
See [Character documentation](/docs/CHARACTER.md) for more info
|
|
Referencing a character using the @, @NARRATOR is reserved for the Narrator.<br/>
|
|
Customisation is done with @CHARACTER change \<feature\> into \<feature name\><br/>
|
|
Move a character with @CHARACTER to fr
|
|
|
|
> [!NOTE]
|
|
> fr means front-right for instance.
|
|
|
|
## Outputs
|
|
|
|
```
|
|
@CHARACTER says "this string
|
|
is multi-line
|
|
and ends with a"
|
|
```
|
|
|
|
## Variables
|
|
|
|
Variables are referenced with the \$, only integers will be supported.<br/>
|
|
|
|
## Selection
|
|
|
|
Condition based:
|
|
|
|
```
|
|
if (condition) {
|
|
|
|
}
|
|
|
|
elif (condition) {
|
|
|
|
}
|
|
|
|
else
|
|
|
|
}
|
|
```
|
|
|
|
Choice based:
|
|
|
|
```
|
|
choice "choice 1" {
|
|
|
|
}
|
|
|
|
or "choice 2" {
|
|
|
|
}
|
|
|
|
or "choice 3" {
|
|
|
|
}
|
|
```
|
|
|
|
## Positioning
|
|
|
|
```
|
|
@CHARACTER to position
|
|
|
|
PAN to position
|
|
```
|
|
|
|
## Other
|
|
|
|
```
|
|
label:
|
|
|
|
GOTO label
|
|
```
|
|
|
|
## Ending
|
|
|
|
`END` to exit out of the story
|