spine-runtimes/spine-as3

spine-as3

The spine-as3 runtime provides functionality to load and manipulate Spine skeletal animation data using Adobe's ActionScript 3.0 (AS3). The spine.flash package 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.

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-as3 works with data exported from Spine 4.0.xx.

spine-as3 supports all Spine features, including meshes. If using the spine.flash classes for rendering, meshes, clipping, and two color tinting are not supported.

Usage

1. Create a new Flex or Adobe AIR project in your preferred IDE.
2. Download the Spine Runtimes source using git (git clone https://github.com/esotericsoftware/spine-runtimes) or download it as a ZIP by clicking the download button above.
3. Add the sources from spine-as3/spine-as3/src/ to your project

Example

The Spine AS3 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 32 SDK & Compiler and extract it to a folder.

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

1. Open the spine-as3-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 AS3 Example launch configuration.

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

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

Notes

• Atlas images should not use premultiplied alpha.