inkle/ink is an open-source project on GitHub with 5.0k stars, written primarily in C#. inkle's open source scripting language for writing interactive narrative.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Ink is inkle's scripting language for writing interactive narrative, both for text-centric games as well as more graphical games that contain highly branching stories. It's designed to be easy to learn, but with powerful enough features to allow an advanced level of structuring.
Here's a taster from the tutorial.
- I looked at Monsieur Fogg
* ... and I could contain myself no longer.
'What is the purpose of our journey, Monsieur?'
'A wager,' he replied.
* * 'A wager!'[] I returned.
He nodded.
* * * 'But surely that is foolishness!'
* * * 'A most serious matter then!'
- - - He nodded again.
* * * 'But can we win?'
'That is what we will endeavour to find out,' he answered.
* * * 'A modest wager, I trust?'
'Twenty thousand pounds,' he replied, quite flatly.
* * * I asked nothing further of him then[.], and after a final, polite cough, he offered nothing more to me. <>
* * 'Ah[.'],' I replied, uncertain what I thought.
- - After that, <>
* ... but I said nothing[] and <>
- we passed the day in silence.
- -> END
Getting started
Download Inky, our ink editor, and the follow either:
The basics tutorial if you're non-technical and/or if you'd like to use ink to make a web-based interactive fiction game
The full tutorial if you want to see everything that ink has to offer.
For those who are very technically-minded, you can also use inklecate directly, our ink command line compiler (and player).
To keep up to date with the latest news about ink sign up for the mailing list.
Writing with Unity
Download the latest ink-unity-integration package, or grab it from the Unity AssetStore, and place in your project.
Create a .ink text file such as myStory.ink, containing the text Hello, world!.
Select the file in Unity, and you should see a Play button in the file's inspector.
Click it, and you should get an Editor window that lets you play (preview) your story.
Ink is the core narrative engine itself, written in C#. It includes the code for the compiler. If you're not technical, you don't need to worry about this.
Inky is our ink editor, which is a text editor with support for playing as you write. If you're just starting out with ink, this is all you need.
ink-unity-integration is a plugin to allow you integrate the ink engine with a Unity game. It includes the full Ink engine source.
inklecate is a command-line compiler for ink. Inky uses it behind the scenes.
inkjs is a JavaScript port of the ink engine, useful for powering web-based game. This is included when you export a story for web within Inky.
inkle is the game development studio that created ink
inklewriter is an unrelated interactive story creation tool that designed to be easy to use, but is far less powerful. It's possible to export inklewriter stories to ink, but not vice versa.
What you need if you are a:
Writer: Inky
Unity game developer: ink-unity-integration plugin. Optionally, Inky if you're reading/writing the ink too.
Web-game author: Inky
Versioning
The intention is the following:
Each latest ink/inky/ink-unity-integration release on each Github release page should work together. Ink and Inky version numbering are separate though. You can see which version of the ink engine Inky has in the About box.
ink / ink-unity-integration should effectively have the same version of the same engine, except that the integration might have additional Unity-specific extra minor releases. Their X.0.0 and 0.Y.0 version numbers should match. The 0.0.Z version number in ink-unity-integration may diverge to reflect Unity-specific changes.
inkjs is maintained by the community (primarily @y-lohse and @ephread). It's usually one major version behind the main ink engine, but they work hard to catch up after each release!
The ink engine also has story-format and save-format versions that are internal to the code (see Story.cs and StoryState.cs).
Advanced: Using inklecate on the command line
Download the latest version of inklecate (or build it yourself, see below.)
Create a text file called myStory.ink, containing the text Hello, world!.
On the command line, run the following:
Mac or Linux:./inklecate -p myStory.ink
Windows:inklecate.exe -p myStory.ink
The -p option uses play mode so that you can see the result immediately. If you want to get a compiled .json file, just remove the -p option from the examples above.
Follow the tutorial: Writing with Ink.
Integrating into your game
Full article: see Running Your Ink.
For a sample Unity project, see The Intercept.
Ink comes with a C#-based (or JavaScript-based runtime engine that can load and run a compiled ink story in JSON format.
To compile the ink, either export from Inky (File -> Export to JSON). Or if you're using Unity, you can use the ink-unity-integration package which will automatically compile your ink for you whenever you edit it either in Inky or in an editor of your choice.
Advanced: You can also use the inklecate command line tool to compile ink stories, or you can call the compiler from C# code yourself.
ink isn't designed as an end-to-end narrative game engine. Rather, it's designed to be flexible, so that it can slot into your own game and UI with ease. Here's a taster of the code you need to get started:
using Ink.Runtime;
// 1) Load story
_story = new Story(sourceJsonString);
// 2) Game content, line by line
while(_story.canContinue)
Debug.Log(story.Continue());
// 3) Display story.currentChoices list, allow player to choose one
Debug.Log(_story.currentChoices[0].text);
_story.ChooseChoiceIndex(0);
// 4) Back to 2
...
The development of ink
Build Requirements
All Environments:
.NET SDK 6.0 or newer
Optionally Visual Studio Code
Windows (Optional):
Visual Studio (e.g. Community edition); required to build nuget package with multi-targeting of .NET Framework 3.5
Xamarin, or Unity's own version of MonoDevelop
Mac (Optional):
Visual Studio for Mac
Xamarin, or Unity's own version of MonoDevelop
Building with Visual Studio
Load up the solution file - ink.sln.
Select the Release configuration and choose Build -> Build All (or Build Solution in Visual Studio).
The compiler binary should be built in inklecate/bin/Release (or x86), while the runtime engine DLL will be built in ink-engine-dll/bin/Release/ink-engine.dll
Building with command-line
cd to the project you want to build (e.g., cd inklecate)
Build using dotnet: dotnet build -c Release
To run console apps: dotnet run -c Release
To produce self-contained executable: dotnet publish -r win-x64 -c Release --self-contained
Recommended RIDs for the platform (-r) are: win-x64, linux-x64, and osx-x64
To run the binaries, you need to install .NET Runtime 6.0 or newer (included in SDK).
Need help?
Discord - we have an active community of ink users who would be happy to help you out. Discord is probably the best place to find the answer to your question.
GitHub Discussions - Or, you can ask a question here on GitHub. (Note: we used to use Issues for general Q&A, but we have now migrated.)
How to contribute
We’d of course appreciate any bug fixes you might find - feel free to submit a pull request. However, usually we're actively working on a game, so it might take a little while for us to take a look at a non-trivial pull request. Apologies in advance if it takes a while to get a response!
Architectural overview
See the architectural overview documentation for information about the pipeline of the ink engine, and a birds-eye view of the project's code structure.
License
ink is released under the MIT license. Although we don't require attribution, we'd love to know if you decide to use ink a project! Let us know on Twitter or by email.
Support us!
ink is free forever, but represents multiple years of thought, design, development and testing. Please consider supporting us via Patreon. Thank you, and have fun!
inkle/ink has 5.0k GitHub stars — refresh the page for the live number, or check github.com/inkle/ink. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is inkle/ink open source?
Yes — inkle/ink ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/inkle/ink.
What is inkle/ink?
inkle/ink (inkle/ink) is a C# project on GitHub. From the project's own README: inkle's open source scripting language for writing interactive narrative.
Where can I see inkle/ink in action?
The project maintains a homepage at http://www.inklestudios.com/ink. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about inkle/ink?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/inkle/ink is the definitive source.
Read full README in the tab above.
Is ink worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of ink.