From f5114767f420b33c38986e291fb292ec07490df8 Mon Sep 17 00:00:00 2001 From: David Masad Date: Sat, 30 Jan 2021 15:04:05 -0500 Subject: [PATCH] Adding links --- Readme.md | 6 ++++-- docs/Tutorial.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 708c598..4f52ae7 100644 --- a/Readme.md +++ b/Readme.md @@ -60,7 +60,9 @@ You prep your ship to jump. (This example uses the `<>` widget from `storymanager-widgets.tw`) -You can see this complete example in the `examples\` folder ([twee]() or [playable 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)). + +There's also a [more detailed tutorial](https://github.com/dmasad/StoryletManager/blob/main/docs/Tutorial.md) ### What is a parameterized storylet? Storylets are pieces of content for a story or game that become available based on some combination of the current state, player choice, and random chance. Parameterized storylets are storylets where some details are intended to be filled in with data from the current story state or some underlying world model. For example, your game might have different characters in different locations, each with a different piece of information to share. You can create a single dialog parameterized storylet, with the character as a parameter. Using StoryManager (or, frankly, your own storylet system) your game could look up which characters are present at the game's current location and offer one dialog storylet for each. @@ -70,7 +72,7 @@ There are a bunch of great resources for learning more about storylets in genera ### Why another storylet manager? If you want to do storylets in Twine and Sugarcube, you should first check out [Tiny-QBN](https://github.com/JoshuaGrams/tiny-qbn), which is more mature than this one and requires much less messing around with JavaScript. As of version 3.2.0, the Harlowe story format also has [storylets as a first-class feature](https://twine2.neocities.org/#macro_storylet). -I have a few Twine hobby projects in various stage of completion, and I found myself implementing world-models and procedural generation in JavaScript and trying to tie them to passages. Instead of writing ad-hoc systems per game, I decided to try and make one unified storylet manager -- hence this project. The JavaScript that goes into the StoryManager tool itself is pretty simple (seriously, [look at it]()), but I'm hoping someone else might find this useful too. +I have a few Twine hobby projects in various stage of completion, and I found myself implementing world-models and procedural generation in JavaScript and trying to tie them to passages. Instead of writing ad-hoc systems per game, I decided to try and make one unified storylet manager -- hence this project. The JavaScript that goes into the StoryManager tool itself is pretty simple (seriously, [look at it](https://github.com/dmasad/StoryletManager/blob/main/storymanager.js)), but I'm hoping someone else might find this useful too. ## Feature list diff --git a/docs/Tutorial.md b/docs/Tutorial.md index 6a5346b..159371a 100644 --- a/docs/Tutorial.md +++ b/docs/Tutorial.md @@ -286,7 +286,7 @@ And we'll create the corresponding storylet passage, which will also implement t [[Keep circulating | Start]] ``` -You can view the full code in [examples\tutorial.tw](https://github.com/dmasad/StoryletManager/blob/main/examples/tutorial.tw) or [play it online](). +You can view the full code in [examples\tutorial.tw](https://github.com/dmasad/StoryletManager/blob/main/examples/tutorial.tw) or [play it online](https://dmasad.github.io/StoryletManager/examples/tutorial.html). ## Finishing touches @@ -399,4 +399,4 @@ And that's it! You can compile the final game (such as it is) with ``` > tweego storymanager.js storymanager-widgets.tw examples\duchess_party.js examples\duchess_party.tw -o examples\duchess_party.html ``` -You can view the full code in the [examples folder](https://github.com/dmasad/StoryletManager/tree/main/examples) or [try playing it](). \ No newline at end of file +You can view the full code in the [examples folder](https://github.com/dmasad/StoryletManager/tree/main/examples) or [try playing it](https://dmasad.github.io/StoryletManager/examples/duchess_party.html). \ No newline at end of file