Escoria Ink Bridge

This addon for Godot adds support for playing
Ink scripts in
Escoria adventure game framework.

Ink was created by Inkle Studios. This addon
is not affiliated with Inkle Studios at all.

Please use the deep entertainment issue tracker
if you encounter any problems or require features.

Requirements

• Godot 3.5
• inkgd 0.5.0
• ink 1.1.1
• escoria-core, Escoria 4.0.0a
• Any UI and dialog manager for Escoria (testing using the defaults)

Installation

Download a zip of the repo and copy the plugin (from the addons folder) into a Godot project. The sample project can be used for testing.

Using

The addon expects that ink scripts, which are compiled with
inklecate or inky to JSON files are located
in the project directory.

To start an ink script from Escoria, use the following ESC command:

play_ink res://path/to/ink_script.ink.json

This will play the specified compiled ink script using the configured
Escoria dialog manager.

Conventions

The addon uses the following conventions:

• Each line of text starts with the global id of the speaking characters,
  followed by a : before the actual text starts
• The first tag
  in each line of text will be used for the translation/voice key
• If a line of text starts with two arrows >>, the following is interpreted
  as an ESC command
  and run directly
• Ink global variables are synchronized with Escoria's globals.

Contributing

Clone the repo. Make sure changes work in the test scenes.