bondage.js
Yarn parser for Javascript, in the same vein as YarnSpinner.
Usage
As a Web Tool
To run through your yarn files in your browser, go to http://hayley.zone/bondage.js, paste your yarn data in the field, then hit "compile".
As a Command Line Tool
Installation: npm install -g bondage
Now you can use the bondage
command to run through Yarn files from the command line. You can load one or multiple files at a time. If you load multiple files and a two nodes are encountered with the same name, the node will be overwritten.
Examples
- Running a single file from the default start node (named "Start"):
bondage run yarnfile.json
- Running a single file from the specified node name:
bondage run -s StartNode yarnfile.json
- Running multiple files from the specified node name:
bondage run -s StartNode yarnfile1.json yarnfile2.json ...
- See the compiled ast:
bondage compile --ast yarnfile.json
- See the tokenized input:
bondage compile --tokens yarnfile.json
As a Library
Web
Include dist/bondage.min.js somewhere in your html, and the bondage
variable will be added to the global scope. You can then access everything in the example below (such as bondage.Runner
) through that variable.
Node
Installation: npm install bondage
const fs = ;const bondage = ; const runner = ;const yarnData = JSON; runner; // Loop over the dialogue from the node titled 'Start'for const result of runner // Do something else with the result if result instanceof bondageTextResult console; else if result instanceof bondageOptionsResult // This works for both links between nodes and shortcut options console; // Select based on the option's index in the array (if you don't select an option, the dialog will continue past them) result; else if result instanceof bondageCommandResult // If the text was inside <<here>>, it will get returned as a CommandResult string, which you can use in any way you want console; // Advance the dialogue manually from the node titled 'Start'const d = runnerlet result = dnextvalue;let nextResult = dnextvalue;// And so on
For usage of the yarn format itself, please see the YarnSpinner Documentation, everything there should carry here too (if something does not match up, please open an issue).