No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Example
Scripts
Example.meta
Inklewriter.dll
Inklewriter.dll.meta
Scripts.meta
license.txt
license.txt.meta
readme.md
readme.md.meta

readme.md

InklewriterUnity

InklewriterUnity is library for parsing and displaying inklewriter story files through the Unity game engine. The project is built around InklewriterSharp, an unofficial C# reimplementation of inkle studios' interactive story system.

Instructions

  1. Create a new Unity project and copy the InklewriterUnity repository into the the project's Assets folder.
  2. Write a story with inklewriter.
  3. Generate a share link for your story and append .json to the end of its URL.
  4. Download your story json file and place it in a Resources folder within your Unity project.
  5. Copy all illustration images into your project's Resources folder.
  6. Instantiate the Inklewriter Story Player prefab into your scene. In the inspector, set Story Player's "Story Name" inspector value to the name of your story json file, excluding the .json file extension.
  7. Enter play mode. Your story will be shown in a UI very similar to the inklewriter web player. You may modify this prefab to suit your game's graphical style, or build your own custom UI widgets using standard Unity 5 UI components.

License

The InklewriterUnity source code is licensed under the MIT License. Inkle story files may be used commercially with a credit to inkle studios.