Skip to content

ephread/inkgd

main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

inkgd

build Documentation Status Version Godot Version License

Implementation of inkle’s Ink in pure GDScript, with editor support.

⚠️ Note: While the implementation of the runtime is feature-complete and passes the test suite, it’s unlikely to ever be considered “production-ready”. inkgd shines for rapid-prototyping in GDScript and small games, but for bigger projects it’s likely to be too slow. If you need a more bulletproof solution and don’t mind C#, you should consider using godot-ink.

Table of contents

Features

  • Fully-featured Ink runtime
  • Advanced editor features
    • Automatic recompilation of managed stories
    • Integrated story previewer

Requirements

  • Godot 3.3+
  • Inklecate 1.0.0+

Asking Questions / Contributing

Asking questions

If you need help with something in particular, start a discussion. If you want to report a problem, open an issue.

Contributing

If you want to contribute, be sure to take a look at the contributing guide.

Installation & Getting Started

inkgd is available on Godot's Asset Library. The full documentation is hosted on Read The Docs.

Editor Plugin

Ink panel demo

Compatibility Table

inkgd version inklecate version Godot version
0.1.0 – 0.1.4 0.8.2 – 0.8.3 3.1 – 3.2.1
0.2.0 – 0.2.1 0.9.0 3.1 – 3.2.1
0.2.2 0.9.0 3.2 – 3.2.3
0.2.3 0.9.0 3.2 – 3.4
0.3.0 1.0.0 3.2 – 3.4
0.4.0 – 0.4.7 1.0.0 3.3 – 3.5

Acknowledgement

Code

  • inkgd is based on the original C# implementation, released under the MIT license, copyright inkle Ltd.
  • inkgd uses code ported from godot-ink, released under the MIT license, copyright Paul Joannon.

Ink Stories

  • The Intercept and Crime Scene, released under the MIT license, copyright inkle Ltd. The sample project uses slightly modified versions of these two stories.
  • LD41 Emoji, released under the MIT license, copyright Pat Scott.
  • Not a halloween game, released under the MIT license, copyright Samuel Sarette and Zachary Sarette.

Documentation & Tutorials

  • @videlanicolas started the documentation project on ReadTheDocs.
  • Nicholas O'Brien did a whole video series about inkgd & Godot.

License

inkgd is released under the MIT license. See LICENSE for details.

About

Implementation of inkle's Ink in pure GDScript for Godot, with editor support.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages