nathanmcrae/StoryletManager
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Readme tweak

Browse Source
This commit is contained in:
David Masad
2021-02-28 10:50:57 -05:00
parent f3bafb8d35
commit 74c27cba67
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Readme.md
View File

@ -9,7 +9,6 @@ You can use it in the Twine interactive editor, but at the moment it's probably
Add `storymanager.js` to your Twine project. In JavaScript, add some story data if needed, and then add a storylet with a name, some tags (optionally), and a `generate` generator function* that `yield`s one or more instantiated storylet objects, like this: Add `storymanager.js` to your Twine project. In JavaScript, add some story data if needed, and then add a storylet with a name, some tags (optionally), and a `generate` generator function* that `yield`s one or more instantiated storylet objects, like this:
```javascript ```javascript
State.variables.locations = ["Earth", "Mars", "Ganymede"]; State.variables.locations = ["Earth", "Mars", "Ganymede"];
State.variables.currentLocation = "Deep space"; State.variables.currentLocation = "Deep space";
@ -48,7 +47,7 @@ You take your shuttle down to the surface of $currentLocation.
Return to [[Orbit]] Return to [[Orbit]]
``` ```
And finally, you need to have a passage where you query for available storylets and display them: And finally, you need to have a passage where you query for available storylets and display them. You display available storylets as links using the `<<getStoryletLinks>>` macro
``` ```
:: Jump :: Jump
@ -57,8 +56,20 @@ You prep your ship to jump.
<<getStoryletLinks>> <<getStoryletLinks>>
``` ```
This will add three Twine links: `Jump to Earth`, `Jump to Mars`, and `Jump to Ganymede`. Each one will lead to the `:: Orbit` passage, but with a different value assigned to `$currentStorylet.planet`.
You can see this complete example in the `examples\` folder ([twee](https://github.com/dmasad/StoryletManager/blob/main/examples/tutorial.tw) or [playable HTML](https://dmasad.github.io/StoryletManager/examples/simple_space_example.html)). You can see this complete example in the `examples\` folder ([twee](https://github.com/dmasad/StoryletManager/blob/main/examples/tutorial.tw) or [playable HTML](https://dmasad.github.io/StoryletManager/examples/simple_space_example.html)).
In other cases you might want a single link that chooses the next storylet at random and takes the player there. You do that using the `<<linkToNextStorylet>>` macro:
```
:: Jump
You prep your ship to jump. You can choose a destination:
<<getStoryletLinks>>
Or you can <<linkToNextStorylet "jump blind">>.
```
There's also a [more detailed tutorial](https://github.com/dmasad/StoryletManager/blob/main/docs/Tutorial.md) There's also a [more detailed tutorial](https://github.com/dmasad/StoryletManager/blob/main/docs/Tutorial.md)
### What is a parameterized storylet? ### What is a parameterized storylet?