Storyboard is a general-purpose engine for multilinear/nonlinear storytelling. It's written in JavaScript (ES6), and intended to be embedded within another game or application (such as the included-as-a-git-submodule Storyboard-iOS reference native iOS Swift project)
Right now, it's pre-alpha. Stay tuned for more.
Real documentation is coming later; right now, this really isn't intended for use by anyone other than me.
That being said:
npm install
to install dependenciesgulp
to compile to a production file (dist.js
in the root folder)npm test
runs the test suite. It's got decent coverage at a functional, not unit, level.- If using the reference iOS client,
git submodule update --init
- Put your data files in the
examples
folder, with any media needed in a subfolder with the same name (e.g.sample.json
would have a folder calledsample
)
Knock yourself out.
This project is licensed under the MIT License. See the LICENSE file in this repository for more information.