Skip to content

Latest commit

 

History

History
 
 

YarnSpinner-Unity

README.md

Using Yarn Spinner in your Unity game

Style Guide

Inline Code contain short snippets of code for your project

Code Blocks contain segments or chunks of code for your project

Bold indicate actions (Select menu item, copying file, etc.)

Bold italic text indicates emphasis

Blockquotes contain essential information

Tutorial

Note: This tutorial assumes that you know a little bit about Unity. In particular, it is helpful that you know how to get around the Unity editor, how to work with game objects, and how to write scripts in C#. If you don't know these things, please refer to Unity's documentation. We recommend their tutorials, starting with the Roll-a-ball tutorial. It is also helpful if you know a little about the Yarn Editor.

Yarn Spinner Quick Start

If you're already familiar with Unity and the Yarn Editor, we have a Unity Quickstart guide.

Step by Step

If you've not done much more than install Unity and the Yarn Editor, confirmed that menu and dialogue functions of these applications appear operational and gone through the Unity Roll-a-ball tutorial, our Step By Step guide is intended to walk you through the creation of a very basic game using Yarn Spinner.

Tips during Unity install

Windows

  • If you install to Unity the default file location, find the temp folder the installer has executed from and back it up before it completes installing.
  • If you decide to install Visual Studio seperately, be aware that there are files from this program that insist on being installed on the C:\ drive and that your development experience may be restricted.

Mac

(This space left intentionally blank)

Linux

  • Unity is only officially supported on Ubuntu. YarnSpinner is built on Ubuntu. However, we use Debian for some of our development and testing.
  • Unity for Linux is not available in formal release and we are not actively pursuing this platform, however we are very enthusastic about this future prospect. We have confirmed that Yarnspinner works with the current 5.6 release of Unity for Linux, although this has only been tested with our example Unity code on Debian Stretch (amd64 architecture).
  • npm is needed for Unity. It is available in Debian Jessie, however it is not available in Debian Stretch. For Debian Stretch or later releases, or other Debian derived distributions, please refer to the nodejs.org website.
  • Some 32bit support is required to run Unity. If you are running a 64bit environment, please refer to your distribution's documentation on how to do this. Once you have that enabled, ensure lib32gcc1, lib32stdc++6 and libc6-i386 are installed (eg, sudo apt install lib32gcc1 lib32stdc++6 libc6-i386)
  • We encourge Linux users to test Yarnspinner using the Monodevelop FlatPak. Although FlatPak is designed to be Linux agnostic, we are currently utilising Gnome3 on Debian Stretch for desktop development purposes. Your mileage may vary on other Linux combinations and flavours, we are eager to receive your feedback.