spine-starling

The spine-starling runtime provides functionality to load, manipulate and render Spine skeletal animation data using Starling 2.0. spine-starling is based on spine-as3.

Licensing

You are welcome to evaluate the Spine Runtimes and the examples we provide in this repository free of charge.

You can integrate the Spine Runtimes into your software free of charge, but users of your software must have their own Spine license. Please make your users aware of this requirement! This option is often chosen by those making development tools, such as an SDK, game toolkit, or software library.

In order to distribute your software containing the Spine Runtimes to others that don't have a Spine license, you need a Spine license at the time of integration. Then you can distribute your software containing the Spine Runtimes however you like, provided others don't modify it or use it to create new software. If others want to do that, they'll need their own Spine license.

For the official legal terms governing the Spine Runtimes, please read the Spine Runtimes License Agreement and Section 2 of the Spine Editor License Agreement.

Spine version

spine-starling works with data exported from Spine 4.0.xx.

spine-starling supports all Spine features.

Usage

1. Create a new Starling 2.6 project as per the documentation.
2. Download the Spine Runtimes source using git or by downloading it as a zip via the download button above.
3. Copy the sources in spine-as3/spine-as3/src/ and spine-starling/spine-starling/src/ into your project's source directory.

Example

The Spine Starling example works on Windows, Linux and Mac OS X. This guide assumes you are using Visual Studio Code together with the ActionScript & MXML extension for Visual Studio Code as your development environment.

1. Install Visual Studio Code.
2. Install the ActionScript & MXML extension for Visual Studio Code.
3. Download Adobe Flash Player 32 projector content debugger. On Windows, run it once to store its path.
4. Download Adobe AIR 33 SDK & Compiler and extract it to a folder.

To run the Flash example project spine-starling-example:

1. Open the spine-starling-example/ folder in Visual Studio Code.
2. Set the AIR SDK location when prompted or by pressing CTRL + SHIFT + P (CMD + SHIFT + P on macOS) and choosing >ActionScript: Select Workspace SDK.
3. Launch the Launch Spine Starling Example launch configuration.

Instead of directly adding the sources of from spine-starling/src to your project, you can also link the SWC file spine-starling/lib/spine-starling.swc. To (re-)compile this file yourself with Visual Studio Code:

1. Open the spine-starling/ folder in Visual Studio Code.
2. Press CTRL + SHIFT + B (CMD + SHIFT + B on macOS) and select ActionScript: compile release - asconfig.json

Note that spine-starling depends on the sources of the spine-as3 project. See the asconfig.json file more information on dependencies.