Skip to content

About

Native Spine plugin for Solar2D

Resources

Stars

12 stars

Watchers

5 watching

Forks

Repository files navigation

Solar2D Spine Plugin

A native Spine plugin for Solar2D, enabling seamless integration of Spine animations into your Solar2D projects with enhanced performance and features.

The plugin ships one plugin per Spine line; pick the one that matches the Spine editor you export from:

Spine line Plugin Version Documentation
4.2 plugin.spine42 2.0.1 spineplugin.readthedocs.io/en/4.2
4.3 plugin.spine43 3.0.1 spineplugin.readthedocs.io/en/4.3
legacy plugin.spine 1.2 spineplugin.readthedocs.io/en/1.2

The plugin works on Android, iOS, macOS, and Windows platforms, supporting both Spine JSON and binary formats.

For detailed information on the plugin's API, please refer to the plugin's documentation

📦 Installing plugin.spine42

Add this entry to the plugins table of your project's build.settings. The Simulator and the build download the plugin from the Solar2D Free Plugin Directory:

settings =
{
    plugins =
    {
        ["plugin.spine42"] =
        {
            publisherId = "com.studycat",
        },
    },
}

Then load it with local spine = require("plugin.spine42"). The 4.2 documentation covers the rest.

📦 Installing plugin.spine43

For skeletons exported with Spine 4.3, add this entry instead. The Simulator and the build download the plugin from the Solar2D Free Plugin Directory:

settings =
{
    plugins =
    {
        ["plugin.spine43"] =
        {
            publisherId = "com.studycat",
        },
    },
}

Then load it with local spine = require("plugin.spine43"). The 4.3 documentation covers the rest, and its migration page lists what changes from 4.2.

To stay on one release, add version = "v2" to the entry: v2 is plugin.spine42 2.0.1 and plugin.spine43 3.0.1, and v1 stays on 2.0.0 and 3.0.0. The same archives stay attached to this repository's spine42-2.0.1 and spine43-3.0.1 releases as a fallback: list their URLs in the entry's supportedPlatforms to install from there instead.

🤝 Contributing

I warmly welcome contributions from the community! Whether you’re an expert in native code and plugins or just getting started, your help can make a significant difference.

How to Contribute:

• Report Issues: If you encounter any bugs or have feature requests, please open an issue. • Submit Pull Requests: Feel free to fork the repository and submit pull requests with your improvements. • Collaborate: If you’re unsure where to start, reach out! I’m here to guide you through the code and the build process.

🦴 Using the plugin

This plugin utilizes the Spine Runtime to enable animation functionalities. The Spine Runtime is licensed under the Spine Runtime License, a copy of which is available in our repository. Spine technology by Esoteric Software. Please see Spine’s website for more details on licensing and usage.

A Spine license is required to use this Solar2D plugin.

📄 License

This project is licensed under the MIT License.

📫 Contact

Feel free to reach out for any questions, collaborations, or to share your Spine animations:

Stay tuned for more updates, and thank you for your support!

About

Native Spine plugin for Solar2D

Resources

Stars

12 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages