35 lines
926 B
Markdown
35 lines
926 B
Markdown
# Making a Story
|
|
|
|
## Setting up
|
|
|
|
You need these three files to make a story:
|
|
|
|
- about.json
|
|
|
|
- story.ha
|
|
|
|
- characters.json
|
|
|
|
## Filling out the files
|
|
|
|
Inside about.json should be the following content:
|
|
|
|
```
|
|
{
|
|
"title": "My Great Story",
|
|
"description": "please read!"
|
|
}
|
|
```
|
|
|
|
Change the title and description to whatever you would like.<br/>
|
|
Inside story.ha should be the code for your story, see [the documentation on coding](/docs/SYNTAX.md) for help with this.<br/>
|
|
Finally, inside characters.json should be a JSON formatted object containing all your characters. See [the documentation on characters](/docs/CHARACTERS.md) for help with this file.<br/>
|
|
|
|
## Making a story file
|
|
|
|
A story file is just a zip file of these files, so zip up story.ha, characters.json and about.json into a zip file (make sure these are in the root of the zip file).
|
|
|
|
## Playing your story
|
|
|
|
To play your story, simply run cargo run \<your zip file\>
|