Documentation

spine-as3/README.md

@@ -1,11 +1,11 @@
-# `spine-as3`
+# spine-as3
 
-The spine-as3 runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using Adobe's ActionScript 3.0 (AS3). The [`spine.flash` package](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-as3/spine-as3/src/spine/flash) can be used to render Spine animations using Flash, or spine-as3 can be extended to enable Spine animations for other AS3 projects, such as [Starling](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-starling).
+The spine-as3 runtime provides functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using Adobe's ActionScript 3.0 (AS3). The [`spine.flash` package](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-as3/spine-as3/src/spine/flash) can be used to render Spine animations using Flash. spine-as3 can be extended to enable Spine animations for other AS3 projects, such as [Starling](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-starling).
 
 ## Setup
 
 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. Project files are provided for Adobe Flash Builder 4.6. You will need to create a new project and import the source for other IDEs.
+1. Using Adobe Flash Builder 4.6, import the spine-as3 project by choosing File -> Import -> Existing projects. For other IDEs you will need to create a new project and import the source.
 
 Alternatively, the contents of the `spine-as3/src` directory can be copied into your project.
 

spine-c/README.md

@@ -1,11 +1,11 @@
 # spine-c
 
-The spine-c runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using ANSI C. It does not perform rendering but can can be extended to enable Spine animations for any C-based language, such as C++ or Objective-C.
+The spine-c runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using ANSI C. It does not perform rendering but can be extended to enable Spine animations for other C-based projects, including C++ or Objective-C projects.
 
 ## Setup
 
 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. Project files are provided for Visual C++ Express 2010. You will need to create a new project and import the source for other IDEs.
+1. Open the `spine-c.sln` Visual C++ 2010 Express project file. For other IDEs, you will need to create a new project and import the source.
 
 Alternatively, the contents of the `spine-c/src` and `spine-c/include` directories can be copied into your project. Be sure your header search is configured to find the contents of the `spine-c/include` directory. Note that the includes use `spine/Xxx.h`, so the `spine` directory cannot be omitted when copying the files.
 

spine-cocos2d-iphone/README.md

@@ -1,16 +1,19 @@
-
 # spine-cocos2d-iphone
 
-The spine-cocos2d-iphone runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using [cocos2d-iphone](http://www.cocos2d-iphone.org/). spine-cocos2d-iphone is based on [spine-c](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-c).
+The spine-cocos2d-iphone runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [cocos2d-iphone](http://www.cocos2d-iphone.org/). spine-cocos2d-iphone is based on [spine-c](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-c).
 
 ## Setup
 
 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. Place the `cocos2dx` directory from a cocos2d-x (cocos2d-2.1rc0-x-2.1.2 or later) distribution into the `spine-cocos2dx` directory.
-1. Open the provided XCode (Mac) or Visual Studio Express 2012 (Windows) project file from the `example` directory. Build files are also provided for Android.
+1. Place the `cocos2d`, `CocosDenshion`, and `kazmath` directories from a cocos2d-iphone (v2.1-rc1 or later) distribution into the `spine-cocos2d-iphone/libs` directory.
+1. Open the XCode project file for iOS or Mac from the `spine-cocos2d-iphone` directory.
 
-Alternatively, the contents of the `spine-c/src`, `spine-c/include` and `spine-cocos2dx/src` directories can be copied into your project. Be sure your header search is configured to find the contents of the `spine-c/include` and `spine-cocos2dx/src` directories. Note that the includes use `spine/Xxx.h`, so the `spine` directory cannot be omitted when copying the files.
+Alternatively, the contents of the `spine-c/src`, `spine-c/include` and `spine-cocos2d-iphone/src` directories can be copied into your project. Be sure your header search path will find the contents of the `spine-c/include` and `spine-cocos2d-iphone/src` directories. Note that the includes use `spine/Xxx.h`, so the `spine` directory cannot be omitted when copying the files.
 
 ## Examples
 
-[Simple example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-cocos2dx/example/Classes/ExampleLayer.cpp#L18)
+[Simple example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-cocos2d-iphone/example/ExampleLayer.m#L13)
+
+## Links
+
+[podspec](https://github.com/ldomaradzki/spine-runtimes/blob/master/Spine-Cocos2d-iPhone.podspec)

spine-cocos2dx/README.md

@@ -1,18 +1,15 @@
-
 # spine-cocos2dx
 
-The spine-cocos2dx runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using [cocos2d-x](http://www.cocos2d-x.org/). spine-cocos2dx is based on [spine-c](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-c).
+The spine-cocos2dx runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [cocos2d-x](http://www.cocos2d-x.org/). spine-cocos2dx is based on [spine-c](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-c).
 
 ## Setup
 
 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. Place the `cocos2d`, `CocosDenshion`, and `kazmath` directories from a cocos2d-iphone (v2.1-rc1 or later) distribution into the `spine-cocos2d-iphone/libs` directory.
-1. Open the provided XCode project file for iOS or Mac.
-
-## Examples
+1. Place the `cocos2dx` directory from a cocos2d-x (cocos2d-2.1rc0-x-2.1.2 or later) distribution into the `spine-cocos2dx` directory.
+1. Open the XCode (Mac) or Visual C++ 2012 Express (Windows) project file from the `spine-cocos2dx/example` directory. Build files are also provided for Android.
 
-[Simple example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-cocos2d-iphone/example/ExampleLayer.m#L13)
+Alternatively, the contents of the `spine-c/src`, `spine-c/include` and `spine-cocos2dx/src` directories can be copied into your project. Be sure your header search path will find the contents of the `spine-c/include` and `spine-cocos2dx/src` directories. Note that the includes use `spine/Xxx.h`, so the `spine` directory cannot be omitted when copying the files.
 
-## Links
+## Examples
 
-[podspec](https://github.com/ldomaradzki/spine-runtimes/blob/master/Spine-Cocos2d-iPhone.podspec)
+[Simple example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-cocos2dx/example/Classes/ExampleLayer.cpp#L18)

spine-corona/README.md

@@ -0,0 +1,17 @@
+# spine-corona
+
+The spine-corona runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [Corona](http://coronalabs.com/products/corona-sdk/). spine-corona is based on [spine-lua](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-lua).
+
+## Setup
+
+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-lua` to `spine-corona/spine-lua`.
+1. Run the `main.lua` file using Corona. There are multiple examples that can be enabled by editing this file.
+
+Alternatively, the `spine-lua` and `spine-corona/spine-corona` directories can be copied into your project. Note that the require statements use `spine-lua.Xxx`, so the spine-lua files must be in a `spine-lua` directory in your project.
+
+## Examples
+
+[spineboy Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-corona/examples/spineboy.lua)
+[goblins Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-corona/examples/goblins.lua)
+[dragon Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-corona/examples/dragon.lua)

spine-csharp/README.md

@@ -0,0 +1,17 @@
+# spine-csharp
+
+The spine-csharp runtime provides functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using C# (C Sharp). It does not perform rendering but can be extended to enable Spine animations for other C#-based projects.
+
+## Setup
+
+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. Open the `spine-csharp.sln` Visual C# 2010 Express project file.
+
+Alternatively, the contents of the `spine-csharp/src` directory can be copied into your project.
+
+## Runtimes Extending spine-csharp
+
+- [spine-monogame](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-monogame)
+- [spine-tk2d](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-tk2d)
+- [spine-unity](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-unity)
+- [spine-xna](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-xna)

spine-js/README.md

@@ -0,0 +1,12 @@
+# spine-js
+
+The spine-js runtime provides functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using JavaScript. It does not perform rendering but can be extended to enable Spine animations for other JavaScript-based projects.
+
+## Setup
+
+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. Include the `spine.js` file in your project.
+
+## Runtimes Extending spine-js
+
+- [spine-turbulenz](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-turbulenz)

spine-libgdx/README.md

@@ -0,0 +1,17 @@
+# spine-libgdx
+
+The spine-libgdx runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [libgdx](http://www.libgdx.com/).
+
+## Setup
+
+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. Using Eclipse, import the project by choosing File -> Import -> Existing projects. For other IDEs you will need to create a new project and import the source.
+
+Alternatively, the contents of the `spine-libgdx/src` directory can be copied into your project.
+
+## Examples
+
+[AnimationState Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-libgdx/test/com/esotericsoftware/spine/AnimationStateTest.java#L45)
+[Box2D Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-libgdx/test/com/esotericsoftware/spine/Box2DExample.java#L56) (written before bounding boxes were available)
+[Mix Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-libgdx/test/com/esotericsoftware/spine/MixTest.java#L39)
+[Skeleton Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-libgdx/test/com/esotericsoftware/spine/SkeletonTest.java#L47)

spine-love/README.md

@@ -0,0 +1,15 @@
+# spine-love
+
+The spine-love runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [LÖVE](https://love2d.org/). spine-love is based on [spine-lua](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-lua).
+
+## Setup
+
+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-lua` to `spine-love/spine-lua`.
+1. Run the `main.lua` file using LÖVE.
+
+Alternatively, the `spine-lua` and `spine-love/spine-love` directories can be copied into your project. Note that the require statements use `spine-lua.Xxx`, so the spine-lua files must be in a `spine-lua` directory in your project.
+
+## Examples
+
+[Simple Example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-love/main.lua)

spine-lua/README.md

@@ -0,0 +1,13 @@
+# spine-lua
+
+The spine-lua runtime provides functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using [Lua](http://www.lua.org/). It does not perform rendering but can be extended to enable Spine animations for other Lua-based projects.
+
+## Setup
+
+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 the `spine-lua` directory into your project.
+
+## Runtimes Extending spine-lua
+
+- [spine-corona](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-corona)
+- [spine-love](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-love)

spine-monogame/README.md

@@ -0,0 +1,10 @@
+# spine-monogame
+
+The spine-monogame runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [MonoGame](http://monogame.codeplex.com/). spine-monogame is based on [spine-xna](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-xna) and adds MonoGame project files.
+
+## Setup
+
+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. Open the Windows 8 Store or Xamarin Studio project files in `spine-monogame`.
+
+Alternatively, the contents of the `spine-csharp/src` and `spine-xna/src` directories can be copied into your project.

spine-sfml/README.md

@@ -0,0 +1,15 @@
+# spine-sfml
+
+The spine-sfml runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [SFML](http://www.sfml-dev.org/). spine-sfml is based on [spine-c](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-c).
+
+## Setup
+
+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. Using Eclipse CDT, import the project by choosing File -> Import -> Existing projects. For other IDEs you will need to create a new project and import the source.
+1. Copy the SFML binaries into the `spine-sfml/Debug` directory so they can be found when the example is run.
+
+Alternatively, the contents of the `spine-c/src`, `spine-c/include` and `spine-sfml/src` directories can be copied into your project. Be sure your header search path will find the contents of the `spine-c/include` and `spine-sfml/src` directories. Note that the includes use `spine/Xxx.h`, so the `spine` directory cannot be omitted when copying the files.
+
+## Examples
+
+[Simple example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-sfml/example/main.cpp#L61)

spine-starling/README.md

@@ -0,0 +1,16 @@
+# spine-starling
+
+The spine-starling runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [Starling](http://gamua.com/starling/). spine-starling is based on [spine-as3](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-as3).
+
+## Setup
+
+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. Using Adobe Flash Builder 4.6, import the spine-as3 and spine-starling projects by choosing File -> Import -> Existing projects. For other IDEs you will need to create new projects and import the source.
+
+Alternatively, the contents of the `spine-as3/src` and `spine-starling/src` directories can be copied into your project.
+
+## Examples
+
+[Spine atlas example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-starling/spine-starling-example/src/AtlasExample.as#L21)
+[Starling atlas example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-starling/spine-starling-example/src/StarlingAtlasExample.as#L18)
+[Skin example](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-starling/spine-starling-example/src/GoblinsExample.as#L21)

spine-tk2d/README.md

@@ -1,20 +1,15 @@
-The Spine runtime for Unity with 2D Toolkit comes with an example project which has "spineboy" walking. When clicked, he jumps and the transition to/from walking/jumping is blended smoothly.
+# spine-tk2d
 
-# Requirements
+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).
 
-1. Unity 4.2+
-1. Latest 2D Toolkit
+## Setup
 
-# Instructions
-
-1. Copy `spine-csharp/src` to `spine-unity-tk2d/Assets/Spine/spine-csharp`.
-1. Open the `Assets/examples/spineboy/spineboy.unity` scene.
-1. Import 2D Toolkit into your project.
-
-# Setup Tutorial Video
-
-[![Setup tutorial video](http://i.imgur.com/ldMjjoO.png)](http://www.youtube.com/watch?v=dnQbS9ap-i8)
+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/spine-csharp`.
+1. Open the `spine-tk2d/Assets/examples/spineboy/spineboy.unity` scene file using Unity 4.2+.
+1. Import 2D Toolkit into the project.
 
 # Notes
 
-- Atlas images should use premultiplied alpha.
+- Atlas images must use premultiplied alpha.
+- This slightly outdated [setup tutorial video](http://www.youtube.com/watch?v=dnQbS9ap-i8) may still be useful to some.

spine-xna/README.md

@@ -0,0 +1,10 @@
+# spine-xna
+
+The spine-xna runtime provides functionality to load, manipulate and render [Spine](http://esotericsoftware.com) skeletal animation data using [XNA](http://msdn.microsoft.com/xna/). spine-xna is based on [spine-csharp](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-csharp).
+
+## Setup
+
+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. Open the `spine-xna.sln` Visual C# 2010 Express project file.
+
+Alternatively, the contents of the `spine-csharp/src` and `spine-xna/src` directories can be copied into your project.