learning-ink-unity icon indicating copy to clipboard operation
learning-ink-unity copied to clipboard

Learn to use Ink + Unity

Learning Ink + Unity

Welcome to the online, open-source textbook Learning Ink + Unity!

This book is designed for those who may not have used Ink, Unity, or any other programming language or engine before with the goal to get you started on creating projects.

It doesn't cover everything, but it should be enough to start making things and preparing the way to move on to more advanced projects.


How do I read this?

This book was written in Markdown and designed to be read on GitHub (where it is also hosted).

A future HTML version is planned, but the current design is for reading it as generated on GitHub through clicking on the chapter links below.


Table of Contents

  • Introduction
  • Common Formatting

Code Basics

  • Chapter 1: C#: Variables, Data Types, and Collections
  • Chapter 2: C#: Classes
  • Chapter 3: C#: Object-Oriented Programming
  • Chapter 4: C#: Operators

Editor Basics

  • Chapter 5: Unity: Terms and Concepts
  • Chapter 6: Unity: Scripting Basics
  • Chapter 7: Unity: Windows, Views, and Tools

Using Plugins and Libraries

  • Chapter 8: Ink: Loading Ink-Unity Plugin
  • Chapter 9: Ink: Introducing Story API

Building an Ink-Based UI in Unity

  • Chapter 10: Unity UI: Introducing Canvas and Text
  • Chapter 11: Unity UI: Buttons and User Input
  • Chapter 12: Unity UI: User Events and Dynamic Story Loading

Organizing and Optimizing

  • Chapter 13: Ink: Selective Output and Story Organization
  • Chapter 14: Unity: Organizing Project Files
  • Chapter 15: Unity UI: Integrating Line Breaks and Rich Text Support

Advanced Ink Story API Usage

  • Chapter 16: Ink + Unity: Accessing and Observing Ink Variables
  • Chapter 17: Ink + Unity: Calling Ink Functions

Found a problem or want to help improve this project?

Submit an issue or pull request! Please help me make this a better resource for learning Ink + Unity!


Version

Version Release Date
1.0 June 2020

License

Text and Images

The text and images of this book are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. When using the text or screenshots of this book for academic purposes, please use the following (APA) citation:

Cox, D. (2020). Learning Ink + Unity. GitHub repository. https://github.com/videlais/learning-ink-unity

Code

All code examples are released under a Public Domain (CC0 1.0 Universal) license. You are free to use them for any commercial, hobby, or educational purpose without citation, attribution, or acknowledgement. Go and create freely!

Inky and Ink

Inky and ink, along with its code and logos, are released under the MIT license.