README.md

日本語 | English

SpriteStudioPlayer for Godot

Note: This develop branch is a work-in-progress version. The stable version can be obtained from the main branch or from Releases. The APIs and workflows in this branch may change without notice, and no warranty or support is provided (we cannot respond to feature requests or bug reports).

A high-performance plugin for playing back animations created with OPTPiX SpriteStudio 7 inside Godot Engine. This plugin allows you to easily implement and play back raster-based 2D animations within your Godot projects.

Documentation

Comprehensive documentation is available in the docs/ folder:

• Documentation (English)
• ドキュメント (日本語)

Quick Links (English)

• Installation
• Basic Usage
• Asset Import and Editor Integration
• Scripting and Events
• CLI Conversion and Automation
• Performance Tuning and Advanced Settings
• Build Guide
• Migration from v1.x

Quick Start with GDExtension

We provide two Quick Starts: one for quickly checking the operation using a sample project, and another for setting up your own project.

1. Check Operation with Sample

1. Get Godot Engine: Download a 4.6-series editor from the official site.
2. Download GDExtension: Get the latest package from Releases and extract it.
3. Prepare Sample: Copy the extracted addons folder into the examples/Ringo folder of this repository.
4. Check: Open the examples/Ringo project in Godot Engine and open Ringo.tscn to immediately see the animation working.

2. Introduce to Your Project

1. Install: Copy the addons folder into your Godot project root.
2. Import: Drag & drop your .sspj onto the Godot editor to convert it to .ssab.
3. Play: Add a SpriteStudioPlayer2D node and assign the .ssab to its SSAB Resource property.

For more details, see the Installation Guide.

Overview

This plugin features a powerful asset pipeline that allows you to seamlessly transition between SpriteStudio and Godot, enabling you to update assets instantly.

For the data-flow diagram, key features, supported versions, and more, see the Documentation (English).

Samples

Sample projects based on SDK test projects are available under the examples folder.

• Ringo — Test for Ringo
• allAttributeV7 — Functional test for all attributes
• allPartsV7 — Functional test for all part types
• overall — Comprehensive functional test
• overall_gdextension — Comprehensive test for GDExtension
• ParticleEffect — Test for effect features

Related Repositories

• SpriteStudio7-SDK — The SDK itself, providing libssruntime / libssconverter

License

See LICENSE.txt.