README.md

TwineStory

A module for the Godot Engine for parsing Twine stories (exported to JSON via twine_to_json).

Only compatible with Godot 2.2+ (as the API for RegEx was changed). For use in prior versions, replace .search( with .find( and handle the return values differently.
Binary builds of Godot 2.2+ are available here.

This leverages Twine as a story editor for Godot projects.
You could also use it as a dialog system (example scene will be provided at a later date).
More complex scripting is coming! Global variables, conditional text, text generation via TraceryCpp (when that library and the corresponding Godot wrapper are ready)!

Installation

1. Clone this repository
2. Put it into your Godot project (in folder modules/twine-story)
3. Create a RichTextField in your scene
4. Attach the script story_label.gd to your RichTextField
5. If you haven't already, change your Twine 2 Story format to Snowman
6. Export to HTML, then use twinetojson to make JSON out of it (don't parse markdown using the -m flag): twinetojson -i story_snowman.html -o story.json -p -m
7. Change the script path in the Inspector to your Twine JSON file
8. Connect the meta_clicked signal of the RichTextField to its script
9. ???
10. Profit