https://github.com/emmettbutler/twine-as3

Twine story importer for Actionscript 3
https://github.com/emmettbutler/twine-as3

Last synced: 3 months ago
JSON representation

Twine story importer for Actionscript 3

• Host: GitHub
• URL: https://github.com/emmettbutler/twine-as3
• Owner: emmettbutler
• License: gpl-3.0
• Created: 2013-10-20T15:30:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-24T21:11:27.000Z (about 11 years ago)
• Last Synced: 2024-07-29T01:21:54.165Z (3 months ago)
• Language: ActionScript
• Size: 313 KB
• Stars: 8
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome-actionscript-sorted - twine-as3 - Twine story importer for Actionscript 3 (Unsorted / Other API)

README

        
![](http://www.gnu.org/graphics/gplv3-127x51.png)

Twine for Actionscript

======================

twine-as3 is a set of classes used to import stories written in

[twine](http://www.gimcrackd.com/etc/src/) 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](http://www.flixel.org/) 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](https://github.com/emmett9001/twee) 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 .