日本語 | English

SpriteStudioPlayer for Godot

Introduction

This plugin enables playback of animations created with
OPTPiX SpriteStudio
within the Godot Engine.

To prioritize runtime performance, the plugin is implemented as a C++ module.

To use SpriteStudioPlayer for Godot, you must either:

• Build the Godot Engine editor with the SpriteStudioPlayer custom module, or
• Add the SpriteStudioPlayer GDExtension to your project.

Supported Versions of OPTPiX SpriteStudio

Supports SpriteStudio Ver.6 and Ver.7.
Note: New features added in Ver. 7.1 (text, sound, etc.) are not supported.

Supported Versions of Godot Engine

• 4.5 branch:
  Verified build and execution on Windows / macOS
• 3.x branch:
  Verified build and execution on Windows / macOS

Build

See BUILD.md.

Usage

See USAGE.md.

Samples

Sample projects are available in the examples folder.

Note:
These samples were created for Godot 3.x.
For use with Godot 4.4, please run “Convert Full Project” first.

feature_test

Basic functional test project with the following scenes:

• v6_feature.tscn

  • Verify features supported from SpriteStudio v6.0 to v7.0
  • Enable visibility of nodes you want to inspect
  • Signal & UserData trigger Godot signals when reaching their keys
  • Parameters appear in the console
  • Original project (v6_all.sspj) is located under ssdata/

• sspj_load.tscn

  • Loads SS projects via GDScript and plays selected animations
  • Automatically switches to another SS project when playback finishes

• texture_change.tscn

  • Demonstrates dynamic texture replacement
  • Toggle “Change” in Inspector to switch textures

mesh_bone

Sample using mesh, bone, and effect features for character animation.

particle_effect

Sample demonstrating effect animation features.
Displays one of 40 possible animations.
More animations can be tested through the Anime Pack.

feature_test_gdextension

Test project for GDExtension operation.
Provides the same samples as feature_test.

Contact

For questions, feature requests, or bug reports, please post to Issues.

For private inquiries, contact us via the
Help Center.

=========================================================

CRI Middleware Co., Ltd.
https://www.cri-mw.co.jp/
Copyright © CRI Middleware Co., Ltd.

=========================================================

• SpriteStudio and Web Technology are registered trademarks of Web Technology Corp.
• Other product names are registered trademarks or trademarks of their respective companies.