Skip to content

README.ja.md

Latest commit

 

History

History
93 lines (63 loc) · 5.47 KB

README.ja.md

File metadata and controls

93 lines (63 loc) · 5.47 KB

日本語 | English

SpriteStudioPlayer for Godot

本developブランチは現在開発中のバージョンです。
安定版は mainブランチ または、Releasesから取得してください。

注意: 本書で扱う API・ワークフローは現在開発中のため、予告なく変更される可能性があります。また、本ブランチに関していかなる保証もサポートも提供せず、リクエストやバグ報告への返信もできません。v1.x からの移行手順は別途マイグレーションドキュメントを用意予定です。

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

ドキュメント

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

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

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 で再生されるまでのデータフローは以下の通りです。

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

    subgraph Godot ["Godot プロジェクト (res://)"]
        DOCK[[" SS Import Dock "]]
        BIN[" 生成された .ssab "]
        NODE[[ SpriteStudioPlayer2D ]]
    end

    SS -- "D&Dでインポート" --> DOCK
    DOCK -. "自動生成" .-> BIN
    BIN -- "インスペクタにセット" --> NODE
    NODE -- "再生" --> RENDER{{" 画面 "}}

    classDef generated stroke-dasharray: 5 5;
    class BIN generated;
Loading
  1. ソースアセット: SpriteStudio 7 で作成されたアニメーションは .sspj（プロジェクト）、.ssae（アニメ）、.ssce（セルマップ）および画像として構成されます。
  2. 変換 (Conversion): Godot での高速な再生を実現するため、専用の SS Import Dock（エディタ内蔵）または ssconverter-cli を使用して、最適化されたバイナリ形式（.ssab / .ssqb）に変換します。
  3. Godot ランタイム: 生成されたバイナリを SSABResource として読み込み、SpriteStudioPlayer2D ノードを通じて再生します。内部では libssruntime が高速なレンダリング処理を行います。

サンプル

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

関連リポジトリ

ライセンス

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