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

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.

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.

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.

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

Name		Name	Last commit message	Last commit date
Latest commit History 12 Commits
addons		addons
characters/testcharacter		characters/testcharacter
rooms		rooms
.gitattributes		.gitattributes
.gitignore		.gitignore
.inkgd_compiler.cfg		.inkgd_compiler.cfg
.inkgd_ink.cfg		.inkgd_ink.cfg
LICENSE.md		LICENSE.md
README.md		README.md
default_env.tres		default_env.tres
icon.png		icon.png
icon.png.import		icon.png.import
icon.svg		icon.svg
icon.svg.import		icon.svg.import
project.godot		project.godot
start_game.esc		start_game.esc
test.ink		test.ink
test.ink.import		test.ink.import
test.ink.json		test.ink.json
test.ink.json.import		test.ink.json.import