/godot-ink

Ink integration for Godot Engine.

Primary LanguageC#MIT LicenseMIT

godot-ink

An ink integration for Godot Engine.

Requirements

  • Godot (Mono version) 3.3+
  • ink 1.0.0+

The following export platforms have been tested with Godot 3.3.2:

  • Windows 🗸
  • Linux 🗸
  • WebAssembly 🗸
  • iOS 🗸

I'm pretty sure this will also run fine on MacOS and Android but haven't witnessed it myself yet. If you end up testing an unlisted platform, please create an issue to tell me whether everything works or not.

Contributing

Bug reports, feature/improvement requests

If you're experiencing difficulties with godot-ink, feel free to open an issue on this repo. For bug reports, please use the provided template.

Contributing

Contributions are, of course, welcome. Be sure to read the contributing guide beforehand, and to add yourself to the AUTHORS file.

Support the development

If you like godot-ink, please consider buying me a coffee.

ko-fi

Installation

The installation process is a bit brittle at the moment, but as long as you're doing everything in order, everything should be alright.

  1. Install godot-ink either through the Asset Library or by dropping the addons/paulloz.ink/ folder in your project's addons/ folder.
  2. Check your project contains a .csproj file.
    • If not, there's a menu for that in Godot:
      Project → Tools → Mono → Create C# Solution
  3. Download the last ink release.
  4. Drop the ink-engine-runtime.dll at the root of your project.
  5. Reference said file in your .csproj file. 
    <ItemGroup>
    <Reference Include="Ink">
    <HintPath>$(ProjectDir)/ink-engine-runtime.dll</HintPath>
    <Private>False</Private>
    </Reference>
</ItemGroup>
  6. Build your project.
  7. Enable godot-ink in the plugins tab of the project settings window.

When the plugin is properly loaded, you should be able to use the new ink preview panel to inspect your story.

Optional: configure to compile ink files

If you want to compile ink files directly from Godot, there are a few additional configuration steps.

  1. Extract the entier ink release you downloaded earlier somewhere on your computer.
    • It should contain an executable file named inklecate.
  2. In the project settings window, scroll down to the ink section and point the "Inklecate Path" field to the said executable file.

If you need to, this "Inklecate Path" can be overriden by setting a override.cfg file in the addon folder. This allows different developers on a team to have their version of the ink compiler wherever they want (if so, do not forget to ignore the override.cfg file in your VCS).

inklecate_path = "C:/Path/To/Your/inklecate.exe"

License

godot-ink is released under MIT license (see the LICENSE file for more information).