README.ja.md

日本語 | English

SpriteStudioPlayer for Godot

注意: 本 develop ブランチは現在開発中のバージョンです。安定版は main ブランチ または Releases から取得してください。本ブランチで扱う API・ワークフローは予告なく変更される可能性があり、いかなる保証もサポートも提供しません（リクエストやバグ報告への返信もできません）。

OPTPiX SpriteStudio 7 で作成したアニメーションを Godot Engine 上で再生するためのハイパフォーマンスなプラグインです。 このプラグインを使用することで、ラスターベースの2Dアニメーションを Godot プロジェクトへ簡単に実装・再生することができます。

ドキュメント

詳細な使い方は docs/ フォルダ内のドキュメントを参照してください。

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

クイックリンク (日本語)

• インストール
• 基本的な使い方
• アセットのインポートとエディタ連携
• スクリプト制御とイベント
• CLI コンバートと自動化
• パフォーマンスチューニングと高度な設定
• ビルドガイド
• v1.x からのマイグレーション

GDExtension を用いたクイックスタート

初めての方向けに、サンプルプロジェクトを使用した動作確認と、ご自身のプロジェクトへ導入する手順の2つを用意しています。

1. サンプルで動作確認する

1. Godot Engine の準備: 公式サイト から 4.6 系のエディタをダウンロードします。
2. GDExtension の取得: Releases から最新パッケージをダウンロードし、展開します。
3. サンプルの準備: 取得した addons フォルダを、本リポジトリの examples/Ringo フォルダ内にコピーします。
4. 確認: Godot Engine で examples/Ringo プロジェクトを開き、Ringo.tscn を開くことですぐにアニメーションの動作を確認できます。

2. 自身のプロジェクトへ導入する

1. 配置: 取得した addons フォルダを、ご自身の Godot プロジェクトのルートにコピーします。
2. インポート: .sspj を Godot エディタにドラッグ＆ドロップして .ssab へ変換します。
3. 再生: SpriteStudioPlayer2D ノードを追加し、SSAB Resource プロパティに生成された .ssab を指定します。

詳細は インストールガイド を参照してください。

概要 (Overview)

本プラグインは、SpriteStudio と Godot エディタをシームレスに行き来できる強力なアセットパイプラインを備え、一瞬でアセットを更新することが可能です。

データフロー図、主な機能、対応バージョンなどの詳細は ドキュメント (日本語) を参照してください。

サンプル

examples フォルダ に SDK のテストプロジェクトに基づいたサンプルプロジェクトがあります。

• Ringo — 「りんご」のテスト
• allAttributeV7 — 全属性の機能テスト
• allPartsV7 — 全パーツ種の機能テスト
• overall — 総合的な機能テスト
• overall_gdextension — GDExtension 版での総合テスト
• ParticleEffect — エフェクト機能のテスト

関連リポジトリ

• SpriteStudio7-SDK — libssruntime / libssconverter を提供する SDK 本体

ライセンス

LICENSE.txt を参照してください。