|
|
@@ -2,9 +2,25 @@
|
|
|
|
|
|
The spine-tk2d runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [2D Toolkit](http://www.unikronsoftware.com/2dtoolkit/) for [Unity](http://unity3d.com/). spine-tk2d is based on [spine-csharp](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-csharp) and is very similar to [spine-unity](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-unity).
|
|
|
|
|
|
-A Spine skeleton is a GameObject and can be used throughout Unity like any other GameObject. The `BoneComponent` class allows other GameObjects to follow a bone in a Spine skeleton.
|
|
|
+A Spine skeleton is a GameObject and can be used throughout Unity like any other GameObject. It depends only on Unity's `MeshRenderer`, so it is close to the metal. `SkeletonUtility` allows other GameObjects to interact with the Spine skeleton, to control bones in the skeleton, be controlled by the skeleton, attach colliders, etc.
|
|
|
|
|
|
-## Setup
|
|
|
+spine-tk2d differs from spine-unity in that a TK2D atlas is used instead of a Spine atlas. Also, spine-unity has more tools for automatically importing Spine skeleton data and atlases, while spine-tk2d requires setting up the TK2D manually. spine-unity provides a GameObject that renders a Spine skeleton, so can be used with TK2D (or any other Unity plugin).
|
|
|
+
|
|
|
+## Documentation
|
|
|
+
|
|
|
+The [Spine Unity Examples](http://esotericsoftware.com/forum/viewtopic.php?f=3&t=3318) forum thread has many videos on how to use both spine-unity and spine-tk2d features.
|
|
|
+
|
|
|
+## Quick installation
|
|
|
+
|
|
|
+Download and run this Unity package:
|
|
|
+
|
|
|
+[spine-tk2d.unitypackage](http://esotericsoftware.com/files/runtimes/unity/spine-tk2d.unitypackage)
|
|
|
+
|
|
|
+In the `Assets/examples` folder you will find example scenes that demonstrate various spine-tk2d features. Also see the example scenes in [spine-unity](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-unity).
|
|
|
+
|
|
|
+## Manual installation
|
|
|
+
|
|
|
+To open the spine-tk2d example scenes:
|
|
|
|
|
|
1. Download the Spine Runtimes source using [git](https://help.github.com/articles/set-up-git) or by downloading it [as a zip](https://github.com/EsotericSoftware/spine-runtimes/archive/master.zip).
|
|
|
1. Copy the contents of `spine-csharp/src` to `spine-tk2d/Assets/spine-csharp`.
|
|
|
@@ -17,11 +33,7 @@ To use spine-tk2d in your own Unity project:
|
|
|
1. Copy the `spine-tk2d/Assets/spine-tk2d` to `Assets/spine-tk2d` in your project.
|
|
|
1. Import 2D Toolkit into your project.
|
|
|
|
|
|
-## Examples
|
|
|
-
|
|
|
-* **spineboy** This shows the spineboy skeleton with shadows. First an animation is played that shows the draw order changing and events firing, then spineboy jumps and walks. Click spineboy to jump again. Notice the walk and jump animations are mixed and transition smoothly. The white cube on spineboy's right hand is a separate GameObject that is positioned using a `BoneComponent`.
|
|
|
-
|
|
|
## Notes
|
|
|
|
|
|
- Atlas images should use premultiplied alpha when using the shaders that come with spine-tk2d.
|
|
|
-- This slightly outdated [spine-tk2d setup video](http://www.youtube.com/watch?v=dnQbS9ap-i8) may still be useful.
|
|
|
+- This slightly outdated [spine-tk2d setup video](http://www.youtube.com/watch?v=dnQbS9ap-i8) may still be useful for manual installation.
|
NathanSweet