Home - SpriteStudio/SS6PlayerForUnity GitHub Wiki

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

SS6Player For Unity v2.2.5 : master

SS6Player For Unity v2.1.25 : develop

SS6Player For Unity v2.2.6 : develop_v2_2_0 / sampledevelop

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

はじめに

本ソフトウェアは OPTPiX SpriteStudio で作成したアニメーションを Unity 上で再生するためのプレイヤープログラムのパッケージです。
OPTPiX SpriteStudio 6, 7用です。OPTPiX SpriteStudio 5を使用する場合は SS5Player For Unity を使用してください。

（重要）Ver.2.1 と Ver.2.2 の違い

Ver.2.2.0 で Unity-Nativeモード のデータとクラスに破壊的変更が加えられました。
このため Ver.2.1.x から 2.2.x にアップデートされる場合、Unity-Nativeモードでインポートしたデータは再インポートが必要になります。
※SS6Player モード、Unity-UI モードに影響はありません。

変更内容

Unityエディタ上での動作が変わりました。
例えばアニメーションをシーンに（AnimationClipを適用しないで）配置した際の挙動が違う他、表示の安定性が向上しています。
これはVer.2.1.xで直接マテリアルやレンダラに設定した値群を一度動作クラス内部にバッファリングして描画時に更新するようにしたためです。
※Unity-Nativeモードが提供する機能は Ver.2.1.21 と同じです。
具体的な変更点は更新履歴を確認してください。

Ver.2.1.x のメンテナンス

当面は Ver.2.2.0 と並行でメンテナンスしていきますが、前述の Unity-Native モードの変更による不都合がない場合は、Ver.2.2.x の利用を推奨しております。

（重要）Ver.2.0以降に更新される際の注意点

Ver.2.0以降のバージョンは、シーケンス機能及びカスタムシェーダ機能への対応の関係から、Ver.1.x系とはデータが異なっております。
そのため、Ver.1.x系でインポートしたデータも、Ver.2.xでは再インポートする必要があります。
また、各種機能を操作する際のクラス・関数なども一部削除・新規作成・変更されております（プログラム面でも互換性が失われております）。
ご注意ください。

プレイヤーの対応バージョンについて

SS6Player for Unityは、各バージョンによって対応している SpriteStudio 及び Unity のバージョンが異なっています。
詳細は、こちら（対応バージョン一覧）を参照ください。

初めての方

データのインポート手順

こちらを参照してください。

アニメーションの再生

こちらを参照してください。

スクリプトの解説はこちらを参照してください。

サンプルプログラム

sampledevelopブランチにアニメーション制御のサンプルが含まれていますので参考にしてください。

※Ver.2.0以前は（Unityプロジェクト内の）「SpriteStudio6Sample」というアセットフォルダにサンプルが格納されていましたが、Ver.2.1以降は「SpriteStudio6/Sample」の下に移動しております。ご注意ください。

各ブランチの違い

SS6PUは現在3つのブランチを持っています。

masterブランチ
現在の安定版のバージョンで、原則UnityのAssetStoreで提供されているバージョンと同じものになります（本Wikiの先頭に書かれているバージョンも、原則このバージョンです）。
developブランチ
現在の最新バージョンで、SS6PU本体のみのものです。
原則masterブランチよりも新しく、機能追加やバグ修正が先行して行われているバージョンになります。
ただし、状況によってmasterブランチのものよりも安定性に欠ける場合があります。
sampledevelopブランチ
サンプルコードを集めたブランチです（SS6PU本体はdevelopブランチと同じバージョンが反映されていますので、違いはサンプルの有無となります）。

状況に応じて、必要とするブランチを使い分けていただくことが可能です。

ご注意・プレイヤーの制限

こちらを参照してください。

使用可能なアトリビュートについて

SpriteStudio6上で、SS6Player for Unityで使用可能なアトリビュートだけ表示するには、

本リポジトリの「/plugins/」フォルダ内の「player_settings」フォルダを（フォルダごと）
「マイドキュメント/SpriteStudio/plugins/」にコピー

してください。
※「マイドキュメント/SpriteStudio」の下にサブディレクトリが存在していない場合、サブディレクトリを作成してください。

プロジェクト設定の互換性設定に以下の項目が増え、アトリビュートを制限する事が出来ます。
※SpriteStudio6起動中だった場合、ファイルのコピー後に設定ウィンドウにある「更新」ボタンを押してください。

「SS6PlayerForUnity」
「SS6PU」モードでインポートする際の使用可能アトリビュート設定です。
「SS6PlayerForUnity(Unity-Native)」
「Convert To Unity-Native」モードでインポートする際の使用可能アトリビュート設定です。

使用できるアトリビュートの詳細は互換性一覧を確認してください。
OPTPiX SpriteStudio 互換性の比較表 SS6P for Unity、 Unity-Native
使用できないアトリビュートについてはインポート時に警告を出して無視されます。

お問い合わせ

ご質問、ご要望、不具合のご報告は Issues に投稿してください。
非公開でのお問い合わせを希望される場合は、ヘルプセンターよりお寄せください。
再現データなどの送付が必要な場合も、上記ヘルプセンター経由でファイルを送信してください。

旧バージョンのドキュメントについて

SpriteStudioArchiveをご参照ください。

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

SpriteStudio, Web Technologyは、株式会社ＣＲＩ・ミドルウェアの登録商標です。
その他の商品名は各社の登録商標または商標です。