diff --git a/spine-as3/README.md b/spine-as3/README.md index f4460e0b0..b1370fa1c 100644 --- a/spine-as3/README.md +++ b/spine-as3/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-as3 works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-as3 supports all Spine features, including meshes. If using the `spine.flash` classes for rendering, meshes are not supported. + ## 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). diff --git a/spine-c/README.md b/spine-c/README.md index 8fd0bfa78..10aa796bc 100644 --- a/spine-c/README.md +++ b/spine-c/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-c works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-c supports all Spine features. + ## 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). diff --git a/spine-cocos2d-iphone/2/README.md b/spine-cocos2d-iphone/2/README.md index d1b4e05f8..9283bd840 100644 --- a/spine-cocos2d-iphone/2/README.md +++ b/spine-cocos2d-iphone/2/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-cocos2d-iphone v2 works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-cocos2d-iphone v2 supports all Spine features. + ## 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). diff --git a/spine-cocos2d-iphone/3/README.md b/spine-cocos2d-iphone/3/README.md index dba5a87af..57a903d2a 100644 --- a/spine-cocos2d-iphone/3/README.md +++ b/spine-cocos2d-iphone/3/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-cocos2d-iphone v3 works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-cocos2d-iphone v3 supports all Spine features. + ## 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). diff --git a/spine-cocos2dx/2/README.md b/spine-cocos2dx/2/README.md index 168eb6e43..26f7aa1c0 100644 --- a/spine-cocos2dx/2/README.md +++ b/spine-cocos2dx/2/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-cocos2dx v2 works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-cocos2dx v2 supports all Spine features. + ## 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). diff --git a/spine-cocos2dx/3/README.md b/spine-cocos2dx/3/README.md index ec2bb7c2f..a805cf400 100644 --- a/spine-cocos2dx/3/README.md +++ b/spine-cocos2dx/3/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-cocos2dx v3 works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-cocos2dx v3 supports all Spine features. + ## Setup The setup for cocos2d-x differs from most other Spine Runtimes because the cocos2d-x distribution includes a copy of the Spine Runtime files. This is not ideal because these files may be old and fail to work with the latest Spine editor. Also it means if cocos2d-x is updated, you may get newer Spine Runtime files which can break your application if you are not using the latest Spine editor. For these reasons, we have requested cocos2d-x to cease distributing the Spine Runtime files, but they continue to do so. diff --git a/spine-corona/README.md b/spine-corona/README.md index 878a8ef1b..7a1314fb9 100644 --- a/spine-corona/README.md +++ b/spine-corona/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-corona works with data exported from Spine 2.1.27. Updating spine-corona to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-corona supports all Spine features except for rendering meshes due to Corona having a limited graphics API. + ## 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). diff --git a/spine-csharp/README.md b/spine-csharp/README.md index d1f78e15f..b817fd7e4 100644 --- a/spine-csharp/README.md +++ b/spine-csharp/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-csharp works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-csharp supports all Spine features. + ## 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). diff --git a/spine-js/README.md b/spine-js/README.md index 428d6d714..4bba36178 100644 --- a/spine-js/README.md +++ b/spine-js/README.md @@ -12,6 +12,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-js works with data exported from Spine 2.1.27. Updating spine-js to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-js supports all Spine features. + ## 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). diff --git a/spine-libgdx/README.md b/spine-libgdx/README.md index db3d7570b..b38a2076a 100644 --- a/spine-libgdx/README.md +++ b/spine-libgdx/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-libgdx works with data exported from the latest version of Spine. + +spine-libgdx supports all Spine features and is the reference runtime implementation. + ## 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). diff --git a/spine-love/README.md b/spine-love/README.md index f5e97a6de..7c03cc625 100644 --- a/spine-love/README.md +++ b/spine-love/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-love works with data exported from Spine 2.1.27. Updating spine-love to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-love supports all Spine features except for rendering meshes. + ## 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). diff --git a/spine-lua/README.md b/spine-lua/README.md index af7875595..79a015a1f 100644 --- a/spine-lua/README.md +++ b/spine-lua/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-lua works with data exported from Spine 2.1.27. Updating spine-lua to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-lua supports all Spine features. + ## 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). diff --git a/spine-monogame/README.md b/spine-monogame/README.md index dabc42368..a5ac25e29 100644 --- a/spine-monogame/README.md +++ b/spine-monogame/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-monogame works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-monogame supports all Spine features. + ## 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). diff --git a/spine-sfml/README.md b/spine-sfml/README.md index 24c4f2980..71161fc0e 100644 --- a/spine-sfml/README.md +++ b/spine-sfml/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-sfml works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-sfml supports all Spine features. + ## 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). diff --git a/spine-starling/README.md b/spine-starling/README.md index 5ed2a07aa..991ad6c4a 100644 --- a/spine-starling/README.md +++ b/spine-starling/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-starling works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-starling supports all Spine features. + ## 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). diff --git a/spine-threejs/README.md b/spine-threejs/README.md index 8ff87109d..03a8d0073 100644 --- a/spine-threejs/README.md +++ b/spine-threejs/README.md @@ -1,3 +1,32 @@ # spine-threejs -The spine-threejs runtime is so far just an example of how the integration could be done. NOT stable! +The spine-threejs runtime provides basic functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using [Three.js](http://threejs.org/). spine-threejs is based on [spine-js](https://github.com/EsotericSoftware/spine-runtimes/tree/master/spine-js). + +## Licensing + +This Spine Runtime may only be used for personal or internal use, typically to evaluate Spine before purchasing. If you would like to incorporate a Spine Runtime into your applications, distribute software containing a Spine Runtime, or modify a Spine Runtime, then you will need a valid [Spine license](https://esotericsoftware.com/spine-purchase). Please see the [Spine Runtimes Software License](https://github.com/EsotericSoftware/spine-runtimes/blob/master/LICENSE) for detailed information. + +The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. + +## Spine version + +spine-threejs works with data exported from Spine 2.1.27. Updating spine-threejs to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-threejs supports all Spine features except for rendering meshes. + +## Setup + +To run the example: + +1. Copy the contents of `spine-js` to `spine-threejs/spine-js`. +1. Place the files on a webserver. Images can't be loaded when run from a local directory. +1. Open `spine-threejs/example/index.html` in a web browser. + +## Demos + +- [spine-threejs Demo](http://esotericsoftware.com/files/runtimes/spine-threejs/example/index.html)
+ [spine-turbulenz Demo source](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-threejs/example/index.html) + +## Notes + +- Atlas images should not use premultiplied alpha or rotation. diff --git a/spine-torque2d/README.md b/spine-torque2d/README.md index 1e9279aff..d3ed6de67 100644 --- a/spine-torque2d/README.md +++ b/spine-torque2d/README.md @@ -4,4 +4,4 @@ The Spine runtime for [Torque2D](https://www.garagegames.com/products/torque-2d) https://github.com/GarageGames/Torque2D/tree/master/engine/source/spine -Unfortunately, it is also a bit out of date. An updated Torque2D Spine runtime is planned. +Unfortunately, it is also a bit out of date. diff --git a/spine-turbulenz/README.md b/spine-turbulenz/README.md index abd9dc192..1f80534af 100644 --- a/spine-turbulenz/README.md +++ b/spine-turbulenz/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-turbulenz works with data exported from Spine 2.1.27. Updating spine-turbulenz to [v3.0](https://trello.com/c/tF8UykBM/72-update-runtimes-to-support-v3-0-skewing-scale) and [v3.1](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes) is in progress. + +spine-turbulenz supports all Spine features except for rendering meshes. + ## Setup To run the example: @@ -19,7 +25,7 @@ To run the example: ## Demos - [spine-turbulenz Demo](http://esotericsoftware.com/files/runtimes/turbulenz/example/)
- [spine-turbulenz Demo source](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-turbulenz/example/index.html#L21) + [spine-turbulenz Demo source](https://github.com/EsotericSoftware/spine-runtimes/blob/master/spine-turbulenz/example/index.html) ## Notes diff --git a/spine-unity/README.md b/spine-unity/README.md index 36802a045..a18d0ce90 100644 --- a/spine-unity/README.md +++ b/spine-unity/README.md @@ -12,6 +12,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-unity works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-unity supports all Spine features. + ## Documentation A Spine skeleton GameObject (a GameObject with a SkeletonAnimation component on it) can be used throughout Unity like any other GameObject. It renders through `MeshRenderer`. diff --git a/spine-xna/README.md b/spine-xna/README.md index 4f71b4029..34bd80d26 100644 --- a/spine-xna/README.md +++ b/spine-xna/README.md @@ -8,6 +8,12 @@ This Spine Runtime may only be used for personal or internal use, typically to e The Spine Runtimes are developed with the intent to be used with data exported from Spine. By purchasing Spine, `Section 2` of the [Spine Software License](https://esotericsoftware.com/files/license.txt) grants the right to create and distribute derivative works of the Spine Runtimes. +## Spine version + +spine-xna works with data exported from the latest version of Spine, except linked meshes are [not yet supported](https://trello.com/c/bERJAFEq/73-update-runtimes-to-support-v3-1-linked-meshes). + +spine-xna supports all Spine features. + ## 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).