Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.3 KB

README.md

File metadata and controls

67 lines (45 loc) · 2.3 KB

Twine for Actionscript

twine-as3 is a set of classes used to import stories written in twine to Actionscript 3 data structures. With this, you can easily prototype story-based games in twine and import those stories into flash-based games, including flixel projects.

Put simply: twine's normal output is a web page that shows your story as text and links. With this project, you can make a twine story that outputs as a flash applet.

Usage Patterns

Formatting twine stories for import is a multi-step process:

Once you have a complete twine project, use the twee json exporter to convert your twine .tw file to the JSON data format.

./twee my/file.tw -t json > out.json

Copy this repo's org directory into your project. If your project already contains an org directory, copy org/twine into the existing org directory.

Copy this repo's lib directory into your project. If your project already contains a lib directory, copy lib/as3corelib.swc to the existing lib directory.

Import the library

import org.twine.*;

Embed your exported JSON file anywhere in your code

[Embed(source='../assets/my_story.json', mimeType="application/octet-stream")] public static var twineFile:Class;

Get the story as an imported AS3 array by calling

var pages:Array = (new org.twine.TwineImporter(twineFile)).getPages();

Compile the project by linking to the as3corelib library

mxmlc my/project.as -include-libraries=lib/as3corelib.swc

License

This file is part of twine-as3.

twine-as3 is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

twine-as3 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with twine-as3.  If not, see <http://www.gnu.org/licenses/>.