Yarn-based narrative tool!
Clone or download
Latest commit df65096 Sep 24, 2018

README.md

Jacquard

A Yarn authoring tool for narrative game development.

Jacquard is a tool for authoring Yarn documents, to be used in game engines like Unity and Unreal Engine. It's built to be a spiritual successor of sorts to Twine, so if you've used that before, Jacquard should feel familiar. Yarn syntax is inspired by SugarCube, and a full reference can be found here.

Features:

  • Node-based drag-and-drop editing
  • Automatic syntax validation

Planned features:

  • Bytecode export
  • Syntax highlighting
  • Localization and voiceover reference support
  • Arbitrary text segment tagging
  • Built-in versioning and collaboration features

Downloads: To download the latest version of Jacquard, visit our releases page.

Jacquard visual node view UI

Using Jacquard

Jacquard is designed to empower writers and narrative designers to get their interactive scripts into a game engine as quickly and as easily as possible. User documentation can be found here. If you're looking for a way to parse Yarn files in Unity, we recommend YarnSpinner.

Jacquard debug log UI

Developing Jacquard

Jacquard was bootstrapped with Create React App, and its version-specific documentation can be found here.

If you'd like to help with Jacquard, the most helpful thing you can do is download the application, test it out, and report issues. For Jacquard discussion, join the #jacquard channel on the Narrative Game Dev Slack.

Related Projects