UnityMirror/spine-runtimes
1
0
Fork 0
mirror of https://github.com/EsotericSoftware/spine-runtimes.git synced 2025-12-20 09:16:01 +08:00
Code Issues Packages Projects Releases Wiki Activity
spine-runtimes/spine-ue4
History

README.md

spine-ue4

The spine-ue4 runtime provides functionality to load, manipulate and render Spine skeletal animation data using Unreal Engine 4.18+. spine-ue4 is based on spine-cpp.

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. Please see the Spine Runtimes Software 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 grants the right to create and distribute derivative works of the Spine Runtimes.

Spine version

spine-ue4 works with data exported from Spine 3.7.xx.

spine-ue4 supports all Spine features.

spine-ue4 does not support multiply and screen blending. spine-ue4 does not support pre-multiplied alpha atlases. spine-ue4 does not support two color tinting.

Usage

Please see the spine-ue4 guide for full documentation

  1. Create a new Unreal Engine code project. You don't need to write C++, but the code project is needed for the plugin to compile. See the Unreal Engine documentation or have a look at the example in this repository.
  2. Download the Spine Runtimes source using git (git clone https://github.com/esotericsoftware/spine-runtimes) or download it as a zip via the download button above.
  3. Copy the Plugins folder from this directory to your new project's root directory.
  4. Copy the folder spine-runtimes/spine-cpp/spine-cpp to your project's Plugins/SpinePlugin/Source/SpinePlugin/Public/ folder.
  5. Open the Unreal Project in the Unreal Editor

See the Spine Runtimes documentation on how to use the APIs or check out the Spine UE4 example.

Example

Please see the spine-ue4 guide for full documentation

The Spine UE4 example works on all platforms supported by Unreal Engine. The samples require Unreal Engine 4.18.

  1. Copy the spine-cpp folder from this repositories root directory to your Plugins/SpinePlugin/Sources/SpinePlugin/Public/ directory.
  2. Open the SpineUE4.uproject file with Unreal Editor