本プラグインは OPTPiX SpriteStudio で作成したアニメーションを Godot Engine 上で再生するためのプラグインです。
実行時パフォーマンスを優先するため C++ モジュールの形態になっています。 SpriteStudioPlayer for Godot を利用する場合、SpriteStudioPlayer のカスタムモジュールを組み込んだ Godot Engine の Editor を手元でビルドする必要があります。 このため、後述のビルドが必要になります。
対応する OPTPiX SpriteStudio のバージョン
Ver.6 と Ver.7 に対応しています。
ただし、Ver.7.1 で追加された新機能(テキスト、サウンド等)には未対応です。
対応する Godot Engine のバージョン
本リポジトリをクローンしてください。
git clone https://github.com/SpriteStudio/SSPlayerForGodot.gitSSPlayerForGodot ディレクトリから以下のコマンドを実行し、 Godot Engine と SpriteStudio SDK を取得します。
git clone https://github.com/godotengine/godot.git
git submodule update --init --recursivesetup.bat で上記を行っています。
SSPlayerForGodot ディレクトリ の godot ディレクトリ内でビルドする Godot Engine のブランチを選択してください。
pushd godot
git checkout 4.3
popd pushd godot
git checkout 3.x
popd 以降でビルド環境の構築手順について説明していきます。
必要なツール
- ビルドツール (いずれかを選択)
- VisualStudio 2017 or 2019(推奨)
- MSYS2 + MinGW + gcc + make
- Python 3.6 以降
- scons 3.0 以降
VisualStudio 2019 でのビルド・デバッグを確認しています。
scons は下記でインストールできます。(上記リンクにも記載あり)
python -m pip install sconswinbuild.ps1 でビルド可能です。
PowerShell
$env:PYTHONUTF8=1
.\winbuild.ps1Cmd
set PYTHONUTF8=1
PowerShell.exe -ExecutionPolicy Bypass -File .\winbuild.ps1必要なツール
- Xcode
- Python 3.6 以降
- scons 3.0 以降
- Vulkan SDK for MoltenVK (4 対応用)
Xcode 以外は Homebrew でインストールができます。
brew install python3 scons brew install molten-vkホストアーキテクチャとは異なるアーキテクチャの Godot Engine をビルドする場合や、Universal Binary な Godot Engine をビルドする場合は、molten-vk の代わりに Universal Binary 対応している Vulkan SDK for MoltenVK をインストールしてください。
macbuild.sh でビルド可能です。
./macbuild.sh引数を指定しない場合はホストマシンのアーキテクチャと同じアーキテクチャ向けにビルドします。
アーキテクチャを明示的に指定する場合は arch= に引数を追加してください。
Universal Binary (supports both arm64 and x86_64)
./macbuild.sh arch=universalarm64 (Apple Silicon)
./macbuild.sh arch=arm64x86_64 (Intel)
./macbuild.sh arch=x86_64godot/Godot.app を開いて起動を確認します。
ビルド環境の構築については以上です。
SpriteStudioデータのインポート手順について説明します。
現在の SpriteStudio for Godot プラグインでは sspj ファイルを直接指定する形態になっています。
ご利用のプロジェクト下のフォルダに sspj、ssae、ssce と画像ファイルなどの一式を配置します。
- 「Node を新規作成」から「GdNodeSsPlayer」を選択し、「作成」ボタンを押します。
- インスペクターの「Res Player」から「新規 GdResourceSsPlayer」を選択します。
- GdResourceSsPlayer の「Res Project」から「読み込み」を選択します。
- 「ファイルを開く」ダイアログから「*.sspj」ファイルを選択して開きます。
- 「Animation Settings」を展開「Anime Pack」から再生させる「*.ssae」ファイルを選択します。
- 続いて「Animation」から再生させるアニメーションを選択します。
- Frame をドラッグしたり、Play フラグをオンにすることでプレビューできます。
GdNodeSsPlayer - SsPlayer を扱うノード
├── Res Player - SsPlayer が使用するリソース
│ └── Res Project - sspj ファイル
│ └── CellMap Settings - セルマップの設定
│ ├── ssce File 01 - セルマップ
│ └── ssce File 02 - セルマップ
│
└── Animation Settings - アニメーションの設定
├── Anime Pack - アニメパック
├── Animation - アニメーション
├── Frame - 現在のフレーム
├── Loop - ループ再生フラグ
├── Playing - 再生フラグ
└── Texture Interpolate - テクスチャ補間フラグ
SSPlayer for Godot の実装(v1.2.0時点)では、一度アニメーションをテクスチャにレンダリングした後、Godot のレンダラーによってスクリーンバッファに描画されます。
このテクスチャにレンダリングする際にバイリニア補間をかける場合はフラグをオンに設定します。
この状態では回転して斜めになったパーツのエッジにアンチエイリアスがかかりますが、この動作が好ましくない場合はオフにしてください。
このフラグをオフに設定し、CanvasItem の Texture の FilterMode も Nearest にしておくとスクリーンバッファに描画する際にも補間がかからずピクセルのエッジが明確になります。
例えばピクセルアート系のゲームで利用する場合は、この設定を試してみて下さい。
レンダリングするテクスチャのサイズはSpriteStudio上でアニメーションに設定した「基準枠」のサイズが採用されます。(v1.2.0時点)
GDScript からコントロールできるクラスの役割と主要なメソッドについて説明します。
各クラスが持っている全てのメソッド、プロパティ、シグナルについては Godot の Script 画面で確認してみてください。
SpriteStudio の各種 .ss** ファイルに相当するリソースを管理するクラスがあります。
１つの sspj ファイルに相当するリソースを取り扱うクラスです。 sspj に登録された ssae, ssce, ssee 各々のリソースの取得と設定を行います。
１つの ssce ファイルに相当するリソースを取り扱うクラスです。 現在テクスチャの取得と設定を行うメンバーのみ対応しています。
１つの ssae ファイルに相当するリソースを取り扱うクラスです。 内包しているアニメーションの数、とアニメーション名の取得を行えます。
現在 GdResourceSsProject リソースを設定、取得するアクセサのみです。
GdNodeSsPlayer に前述のリソースを指定することで再生を行います。
以下はファイルの読み込みから再生開始までのシンプルなサンプルコードです。
# GdNodeSsPlayerノードを指します。
## Godot 4
@onread var ssnode = $target
## Godot 3.x
# onready var ssnode = $target
func _ready():
# sspj ファイルを読み込みます。
ssnode.res_player.res_project = ResourceLoader.load("Sample.sspj")
# ssaeファイルとアニメーションを指定します。
ssnode.set_anime_pack("Sample.ssae")
ssnode.set_animation("anime_1")
# アニメーション終了時コールバックの設定
## Godot 4
ssnode.connect("animation_finished", Callable(self, "_on_animation_finished"))
## Godot 3.x
# ssnode.connect("animation_finished", self, "_on_animation_finished")
# ループを指定して再生を開始します。
ssnode.set_loop(true)
ssnode.play()
# アニメ終了時のコールバック関数です
func _on_animation_finished(name):
print("SIGNAL _on_animation_finished from " + name)他にもカレントフレームの指定、一時停止、開始、終了フレーム、FPSの取得など一般的なメソッドがあります。
一覧は Godot の Script 画面で確認してみてください。
GdNodeSsPlayer が発行するシグナルについて説明します。
アニメーション変更時に発行されます。
name：変更したアニメーション名
再生中のアニメーションが終了フレームに到達した時に発行されます。
ループ再生オンでも毎周発行されます。
name：変更したアニメーション名
アニメパック変更時に発行されます。
name：変更したアニメパック名
フレーム位置変更時に発行されます。
frame：変更したフレーム位置
SpriteStudioのシグナルアトリビュートのキーフレーム到達時に発行されます。
command：コマンド名
value：パラメータ名と値のコレクション
ユーザーデータのキーフレーム到達時に発行されます。
- flag：後続の引数が有効かどうかの論理値
- 1：整数が有効
- 2：範囲が有効
- 4：位置が有効
- 8：文字列が有効
- intValue：整数
- rectValue：範囲
- pointValue：位置
- stringValue：文字列
- マスク機能
- 描画モード：ミックス以外もミックス相当になります。
- SpriteStudio Ver.7.1 で追加された新機能(テキスト・サウンド・9スライス・シェイプ)
- パーツカラー
- v1.1.1 で修正済：ミックスの頂点単位の時にX状(三角形の辺部分)の輝度が高くなっています。
- v1.1 で修正済：乗算でテクスチャカラーの割合がエディタより大きくなります。
- インスタンスの独立動作がOnのパーツの再生について
- シーン上で Frame プロパティが 0 以外の状態で Play プロパティを On にして再生開始した場合、独立動作がOnに設定されたインスタンスパーツを再生させた場合、インスタンスパーツの再生フレームがずれることがあります。
- この場合、一旦 Frame プロパティの値を 0 以外に変更後、0 に戻してから再生開始することで一致させられます。
- シェーダー
- SpriteStudio公式の一部のみ対応しています。
- カスタムシェーダーは独自に追加・対応する必要があります。
examples フォルダにサンプルプロジェクトがあります。
サンプルプロジェクトは 3.x 向けに作っているため、4.3 で利用する際は "Convert Full Project" を実行してから利用してください。
基本機能のテストプロジェクトです。
以下のシーンがあります。
- v6_feature.tscn
- SpriteStudio v6.0~v7.0 までの各機能の再生状態を確認できます。
- 確認したい機能ノードの可視性を有効にしてください。
- Signal、UserData はそれぞれシグナル、ユーザーデータのキーに到達したタイミングでGodotのシグナルを発行するようになっています。
- シーンを実行するとコンソールに受信したパラメータが出力されます。
- ssdata サブフォルダにインポート元のプロジェクトファイル(v6_all.sspj)があります。
- sspj_load.tscn
- GDスクリプトからSSプロジェクトをロードしアニメーションを指定して再生するサンプルです。
- アニメーション終了時に別のSSプロジェクトに読み替えるようになっています。
- texture_change.tscn
- 再生中にセルマップリソースのテクスチャを変更するサンプルです。
- インスペクタにある Change のチェックをOn/Offすると切り替わります。
メッシュ、ボーン、エフェクトなどを利用したキャラクターアニメのサンプルです。
エフェクト機能を利用したサンプルです。
シーンに表示されるアニメーションは40種類のうちの一部になります。
インスペクタの Anime Pack からその他のアニメーションも確認できます。
ご質問、ご要望、不具合のご報告は Issues に投稿してください。
非公開でのお問い合わせを希望される場合は、ヘルプセンター よりお寄せください。
再現データなどの送付が必要な場合も、上記ヘルプセンター経由でファイルを送信してください。
=========================================================
株式会社ＣＲＩ・ミドルウェア
https://www.cri-mw.co.jp/
Copyright © CRI Middleware Co., Ltd.
=========================================================
- SpriteStudio, Web Technologyは、株式会社ウェブテクノロジの登録商標です。
- その他の商品名は各社の登録商標または商標です。