sd2 1.0.0

A parser for an interactive scripting engine.

Released 2016-08-01.

To install, run:

haxelib install sd2 1.0.0

See using Haxelib in Haxelib documentation for more information.

Maintainertienery
Websitehttps://github.com/storydev/sd2
Current version1.0.0
StatisticsInstalled 5 times
LicenseMIT
Tags utility

README.md

StoryDev 2

StoryDev 2 is a parser for StoryScript, a scripting language designed for interactive storytelling. It's written in Haxe which allows for cross-target development, allowing you to use your scripts in any language and on any platform. Haxe targets C++, C#, JavaScript, ActionScript, Flash, Neko, PHP, Java, Python and Lua. With frameworks such as OpenFL and Kha, StoryDev can be used for native desktop applications, web applications, mobile devices, and even the Raspberry Pi.

Installing StoryDev 2

To install, use the haxelib git command:

haxelib git sd2 https://github.com/storydev/sd2.git

Using StoryDev 2

StoryDev 2 comes in two parts: The Parser (the thing that parses your scripts), and the Implementation (the Graphical User Interface that displays and runs the parsed results).

Implementation is currently limited to HTML5, but you can implement StoryDev 2 into your engine very easily. All that is required is a user interface that is customised to work with StoryDev 2.

To implement, you can use the technical specification for exactly how StoryDev parses scripts. Tutorials will become available at a later time.

A Simple Example

To get started with a simple example, you can use the command:

haxelib run sd2 create "My Simple Example" js

Which will create the folder "My Simple Example" and copy the JavaScript template files along with starting assets into the folder.

Use cd "My Simple Example" followed by haxelib run sd2 build to build the project. The build command requires project.json to exist in the root of the project's folder.

The project.json structure

If you're creating a custom implementation for StoryDev 2 and you wish to build using the run sd2 build command, a project.json file is required for the run module to work.

Here is the simple structure it requires:

  1. output - This is the output file or folder (depending on target).
  2. target - This is the target language you want to build to. Follow the Haxe manual for more information on targets.
  3. convos - This is an array of strings of all the files to conversations you want to use in your project. Their resource names will be shortened to the name of the file without the extension, so make sure all filenames are unique and do not contain any special characters. Spaces in the file name will create underscores.