Browse Source

Update README.md

Nathan Sweet 11 years ago
parent
commit
ae5e7d582d
1 changed files with 11 additions and 13 deletions
  1. 11 13
      spine-unity/README.md

+ 11 - 13
spine-unity/README.md

@@ -1,20 +1,18 @@
-The Spine runtime for Unity comes with an example project which has "spineboy" walking. When clicked, he jumps and the transition to/from walking/jumping is blended smoothly.
+# spine-unity
 
-# Requirements
+The spine-unity runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [Unity](http://unity3d.com/) directly, without other 3rd party plugins. spine-unity is based on [spine-csharp](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-csharp) and is very similar to [spine-tk2d](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-tk2d).
 
-1. Unity 4.2+
+A Spine skeleton is a single 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.
 
-# Instructions
+## Setup
 
-1. Copy `spine-csharp/src` to `spine-unity/Assets/Spine/spine-csharp`.
-1. Open the `Assets/examples/spineboy/spineboy.unity` scene.
-
-# Setup Tutorial Video
-
-[![Setup tutorial video](http://i.imgur.com/2AyZq01.png)](http://www.youtube.com/watch?v=x1umSQulghA)
+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-unity/Assets/Spine/spine-csharp`.
+1. Open the `spine-unity/Assets/examples/spineboy/spineboy.unity` scene file using Unity 4.2+.
 
 # Notes
 
-- Atlas images should use premultiplied alpha.
-- Unity scales large images down by default if they exceed 1024x1024, which causes the atlas coordinates to be incorrect. To fix this, override the import settings in the Inspector for any large atlas image you have so Unity does not scale it down.
-- Unity 4.3+'s 2D Project defaults causes (atlas) images added to the project to be imported with the Texture Type "Sprite", which may cause artifacts when using Spine's Skeleton shader. To avoid these artifacts, make sure the Texture Type is set to "Texture".
+- Atlas images should use premultiplied alpha when using the shaders that come with spine-unity.
+- This slightly outdated [spine-unity tutorial video](http://www.youtube.com/watch?v=x1umSQulghA) may still be useful.
+- Unity scales large images down by default if they exceed 1024x1024, which causes atlas coordinates to be incorrect. To fix this, override the import settings in the Inspector for any large atlas image you have so Unity does not scale it down.
+- Unity 4.3+'s 2D project defaults cause atlas images added to the project to be imported with the Texture Type "Sprite", which may cause artifacts when using Spine's Skeleton shader. To avoid these artifacts, make sure the Texture Type is set to "Texture".