Getting Started with Ink ObjectsGetting Started with Ink Objects
Thank you for downloading Ink Objects. This package is intended for Ink users with some
familiarity of Unity and C#. If you are not familiar with Ink, check out Inkle’s Writing with Ink
tutorial before getting started with Ink Objects.
With this package, you will be able to build a library of objects inside the Unity Editor and export
them to Ink, where you can access and modify your objects just like any other part of your Ink
story.
Downloading Required FilesDownloading Required Files
First, make sure you have downloaded the files needed to use Ink Objects. As well as the Ink
Objects packages which you (hopefully) have downloaded already on Itch.io, you will need the
Unity Editor.
Downloading Inky is highly recommended, as it provides syntax highlighting and real-time
interactive previewing of your Ink files as you write them.
If you intend to build your game in Unity, the official Ink/Unity Integration allows you to run your
Ink story in Unity and is required for runtime Ink Object monitoring from custom C# scripts.
Getting Set Up in UnityGetting Set Up in Unity
Once you have downloaded what you need, open the Unity Editor. If you intend to use the
Ink/Unity Integration, ensure it has been added to your project and then import the
InkObjectsRuntime
package. If not, import the
InkObjectsBasic
package.
The runtime package contains some additional example files that illustrate the runtime object
features of Ink Objects, and has runtime object support enabled by default. Otherwise it is
identical to the basic package.
While the basic package lacks runtime example files and runtime object support by default,
runtime objects can be enabled simply by opening
InkObjects/Source/InkObjectLibrary.cs
and
uncommenting the first line of code. If you decide to add Ink/Unity Integration to your project
later this can come in handy.
Example Project OverviewExample Project Overview
Before you get started creating your own Ink Objects, spend some time familiarizing yourself
with the included example project. Open the
InkObjects/Example/Ink Files/RPGExampleTest.ink
file in Inky to play with the sample story and get a sense of how to write with Ink Objects.
