Skip to content

index.md

Latest commit

 

History

History
105 lines (75 loc) · 5.86 KB

index.md

File metadata and controls

105 lines (75 loc) · 5.86 KB

SpriteStudioPlayer for Godot

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

OPTPiX SpriteStudio で作成したアニメーションを Godot Engine 上で再生するためのプラグインです。 再生処理は SpriteStudio7-SDK が提供する libssruntime を介して行います。

目次

主な機能 (Key Features)

本プラグインは、Godot Engine 上で SpriteStudio 7 の表現力をフルに引き出すために設計されています。

  • 完全な機能サポート: ボーン階層、メッシュ＆デフォーム、パーティクルエフェクトなど、SpriteStudio 7 の全機能を標準でサポートします。
  • シームレスな統合と強力なアセットパイプライン: Godot のエディタ内に統合された「SS Import Dock」による簡単なインポートに加え、インスペクタから直接 SpriteStudio を開いて再コンバートできる、SpriteStudio と Godot をシームレスに行き来できる強力なアセットパイプラインを提供します。詳しくは アセットのインポートとエディタ連携 をご覧ください。
  • 動的な着せ替え (CellMap Overrides): 実行時にテクスチャ（セルマップ）を差し替えることで、キャラクターのカラーバリエーションや装備変更を簡単に実装できます。
  • シグナルとイベント: タイムライン上に設定した「ユーザーデータ」や「シグナル」を Godot のシグナルとして受け取り、足音の再生やスクリプトのトリガーを正確なタイミングで行えます。
  • 滑らかなスローモーション: サブフレーム補間（Sub-frame interpolation）をサポートし、高リフレッシュレートのモニターやスローモーション演出でもカクつかない滑らかな再生が可能です。
  • 超高速・省メモリ: バックエンドの libssruntime による SIMD 最適化と、パース不要なバイナリ形式（.ssab）により、モバイルなどのリソースが限られた環境でも多数のキャラクターを高速に描画します。

概要 (Overview)

本プラグインを利用してアニメーションを再生する際の流れを以下に示します。

graph LR
    SS[" .sspj / 画像<br>(ソースアセット) "]

    subgraph Convert ["変換プロセス"]
        DOCK[[" SS Import Dock<br>(Godotエディタ内蔵) "]]
        CLI[[" ssconverter-cli<br>(CLIツール) "]]
    end

    subgraph Godot ["Godot ランタイム (res://)"]
        BIN[" .ssab / .ssqb "]
        NODE[[ SpriteStudioPlayer2D ]]
        RT(" libssruntime ")
    end

    SS -- "ドラッグ＆ドロップ" --> DOCK
    SS -- "CI/CDや手動" --> CLI
    DOCK -. "自動生成" .-> BIN
    CLI -. "生成" .-> BIN
    
    BIN -- "インスペクタにセット" --> NODE
    NODE -. "高速再生" .-> RT
    NODE -- "描画" --> RENDER{{" 画面 "}}

    classDef generated stroke-dasharray: 5 5;
    class BIN generated;
Loading

対応バージョン

Note

GDExtension は Godot 4.6 以降から正式サポートされます。

Windows / macOS でのビルドおよび実行を確認しています。

サンプル

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

関連リポジトリ

マイグレーション

v1.x 以前のバージョンからの移行手順については、マイグレーションガイド を参照してください。

ライセンス

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