🎊 2.0.0 is out! 🎊

This is a major overhaul of the Unity side of the plugin, taking advantage of various new features Unity have added over the last few years. The main change is that the plugin no longer needs to generate .json files; but generally most parts of the plugin have been modernised and should be more efficient and robust.

Version 1 will only receive critical fixes from this point on.

Breaking Changes

This comes with some breaking changes to the Unity side of the API, although porting should only take a minute for most developers. See MIGRATION.md for more information.

Credit

This upgrade is built off the work originally done by @SHiLLySiT, as well as @reallyfancy and @ErnSur; most credit for implementing the new features goes to them. Big thanks from me and the Inkle team, and apologies it took me so long to resolve the final bits.

Changelog

• Ink files are now compiled by a Unity ScriptedImporter, replacing the old compile queue and its per-file .json output.
• ⚠️ Breaking: .ink files import as an InkFile asset — no .json is generated. Reference InkFile and use new Story(inkFile.storyJson).
• ⚠️ Breaking: minimum Unity version is now 2022.3 LTS.
• Editing an include (even nested) now reliably reimports its master file(s).
• Errors, warnings and TODOs show on the import inspector and in the console.
• Ink file icons show state badges (error, warning, TODO, include) consistently in the Project window, inspector header and object fields.
• Builds now fail if any ink file has compile errors.
• Ink Player: load a story by assigning an InkFile (not a JSON TextAsset); tethered stories let you edit variables by default; the history-visibility filter and the auto-play controls are now compact popups.
• Ink Player: auto-play can use a fixed random seed to replay the exact same route — seeds both RANDOM()/shuffles and Auto-Choice.
• Editor inspectors and windows rebuilt with UI Toolkit.

🎉 1.3.0 is out! 🎉

Apologies for the (very) long delay in getting this out!

This is likely the final v1 release. We'll continue supporting v1 where bugs occur, but we will soon be releasing v2, which overhauls many parts of the plugin to make use of newer Unity editor features.

• Updated Ink to 1.2.1
• ⚠️ The minimum supported Unity version is now 2022.3 LTS
• Updated for Unity 6: resolves obsolete API warnings (script define symbols now use NamedBuildTarget) and the Unity 6 serialization analyzer warnings
• Removed legacy code paths for Unity versions older than 2022.3, modernising the editor code (e.g. using TypeCache for inspector lookup)
• The demo now works with both the legacy Input Manager and the new Input System

1.2.1 is out!

• Fixes broken demo script

🎉 1.2.0 is out! 🎉

• 🎉 Updated Ink to 1.2.0! See whats new!
• Some significant editor performance improvements
• #173 Add support for automatically adding #INK_RUNTIME and #INK_EDITOR defines. Go to Project Settings -> Ink Settings to toggle it!

1.1.8 is out!

• Update the demo scene to Unity 2020.3.25f1 to improve compatibility with more recent versions
• Fixes a missing GUIStyle in the Ink Player Window in recent versions of Unity
• Optimise the Ink Player Window for large projects
• Automatically populate the changelog on the startup window

1.1.7 is out!

• Rework of the plugin's INCLUDE hierarchy system, allowing for previously unhandled valid setups.
• Changes the OpenInEditor function to use AssetDatabase.OpenAsset, which correctly uses the OS file editor.
• Prevents the Ink Player Window from showing itself when scripts are recompiled.

1.1.5 is out!

Minor one!

• Adds InkSettings.suppressStartupWindow, which can be used to prevent this window from appearing (requested for some CI/CD pipelines).
• Adds links to Discord for community support in help menu, startup window and setting menu.
• Fixes an issue where InkSettings ScriptableObjects wouldn't be unloaded.
• Updates build documentation for this plugin

1.1.3 is out!

This release fixes a bug with the Ink Player Window in 1.1.2, and hopefully resolves the last of issues with the auto-UPM release system we've set up.

1.1.2 is out!

This release includes last week's release of ink 1.1.1.

Other changes:

The InkCompiler.OnCompileInk event now fires once when the compilation stack completes and returns an array of compiled files
Fixes some async threading issues when compiling
Enables installing via the package manager
Choice tags can be viewed by hovering choices in the Ink Player Window
Adds JSON formatting for save states copied or saved via the Ink Player Window
Use the Unity Progress API to show compilation. Useful for large ink projects!
Included files now show their own included files in the Inspector
Various optimisations

1.0.2 is out!

No changes! This exists only to nudge the build at OpenUPM, which is stuck on a slightly earlier commit that has issues on Unity 2019.