SpriteStudio edited this page May 25, 2018 · 375 revisions

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

SS5Player For Unity v1.6.0

Copyright(C) Web Technology Corp. All rights reserved.

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

はじめに

本ソフトウェアは OPTPiX SpriteStudio 5 で作成したアニメーションを Unity 上で 再生するためのプレイヤープログラムのパッケージです。

SS5Player For Unityは開発を終了しました。

現在開発中のSS6Player For Unityはこちらです。
※SS5Player For Unityの今後のサポート等については、こちらを参照してください。  
 
「Ver1.6.0」から「Unity5.2.0」以降対応になります。
Unity5.1.x以前のバージョンをお使いの場合、SS5Player for Unityは1.5.17以前のバージョンをご使用ください。
※Ver.1.6.0とVer.1.5.17の違いは、描画マネージャでメッシュをバッチングする際の処理がUnity5.2以降に最適化されているため、使用メモリや実行速度に違いがある以外、仕様は同じです。
 
「Ver1.5.11」以前のバージョンから「Ver1.5.13」以降へのバージョンアップ時には、データの再インポートが必要になります
各種事情等でデータの再インポートを行えない場合、
Assets/SpriteStudio/ScriptLibrary/Library_SpriteStudio.cs
Assets/SpriteStudio/Script/Script_SpriteStudio_Root.cs
の冒頭にある
#define DRAWPARTS_ORDER_CALCULATEINADVANCE
を注釈化して、ソートの事前計算を行わないで下さい。
※このラベルを未定義にすると、ソートをパーツの優先度アトリビュートでリアルタイムに行います。

「Ver.1.5.0」以降のバージョンは「Ver.1.4.x(Ver.1.4系)」とはインポート後のデータの互換性がありませんので、特に既存プロジェクトへの適用時には注意してください。
※スクリプトなどからの操作仕様についてはVer.1.4系との互換性を保っていますが、アニメーションデータの格納方法やプライオリティのインポート時解決などの仕様が異なっているため、データの再インポートが必要になります。

「Ver.1.3.0」以降のバージョンは「Ver.1.2.x(Ver.1.2系)」とは互換性がありませんので、特に既存プロジェクトへの適用時には注意してください。
本ドキュメントは、原則「Ver.1.4.0」を対象に記載されております。
v1.2系からの移行についてはこちらを参照してください。

v1.4系(最新Ver.1.4.11)についてはv1.4ブランチまたはタグから取得してください(これは近日中に設置されますので少々お待ち下さい)。
v1.3系(最新Ver.1.3.16)についてはv1.3ブランチまたはタグから取得してください。
v1.2系(最新Ver.1.2.33)についてはv1.2ブランチまたはタグから取得してください。
1.2系ドキュメントはこちら
過去のバージョンはこちらから取得できます

サポート予定について

冒頭の通り、SS5Player for Unityは開発が終了いたしました。
そのため、2017年12月10日以降、新規機能などは実装されません。
Ver.1.6.0からUnity5.2.0以降対応となったことや、後継的位置づけのSS6Player for UnityがSpriteStudio5のデータを(互換性の問題から)インポートすることができないため、一定期間(バグ改修などの)メンテナンスは続行いたします。
対象バージョンとしては、Ver.1.6.0及び(Unity5.1.x以前対応最終版の)Ver.1.5.17になります。

そのため、特に開発中のプロジェクトにおかれましては、Unityのバージョン・SpriteStudioのバージョンなどをご考慮いただいた上で、

  • SS5Player for Unity 1.5.17(SpriteStudio5.8・Unity3.57~Unity5.6対応)
  • SS5Player for Unity 1.6.0(SpriteStudio5.8・Unity5.2~Unity5.6対応)
  • SS6Player for Unity(SpriteStudio6・Unity2017.1~対応)

のいずれを使用するかをご判断くださいますようお願い致します。
※Ver.1.5.17とVer.1.6.0の違いは、(描画マネージャの)メッシュバッチングの処理に違いがあるため、速度や使用メモリの特性が若干変更されている以外は、同じ仕様になります。

Unity5.5.0について

Unity5.5.0を使用する場合SS5PlayerForUnity1.4.8以降を使用してください。
Unity5.5.0ではテクスチャをインポートする挙動が変更され、iOSをターゲットに設定した場合に長方形のテクスチャが正方形に補正されます。
これによって長方形のテクスチャを使用しているアニメーションのUVがずれ、アニメーションが崩れて表示される問題が発生します。

SS5PlayerForUnity1.4.8ではUnity5.5.0で使用した場合に

  • テクスチャをSpriteとしてインポートする事にしました。
    iOSビルドの場合は次のような挙動になります。
    • Spriteは正方形テクスチャの場合、Unityのディフォルトの圧縮が適用されます。
      圧縮を行わない場合はオーバーライド設定でフォーマットを指定してください。

    • Spriteは長方形テクスチャの場合、圧縮されず比率が守られます。
      圧縮が行われないためテクスチャサイズが大きくなります。

マルチプラットフォームを前提に作成する場合、テクスチャは正方形で作成しておく方がよいかと思います。

バージョン1.5.x概要

SS5Player for Unityの本バージョンは、先までのVer.1.4系と比較して下記の点の仕様が変更されております。

  • 「Calculate In Advance」オプション設定時のデータの格納方法(圧縮方法)が変わり、Ver.1.4.xよりも圧縮効率が向上しています(従来の変化点抽出に加え、GoF-Flyweightパターンでの容量軽量化)。
  • 優先度でのスプライトの描画順序を、(Ver.1.4.系までのリアルタイムでのソートから)インポート時に解決(ベイク)する仕様に変わりました。これによって、実行時の動作速度が平均1.2~1.5倍ほど高速になっています。
  • 今後の拡張などを考え、アトリビュートの格納方法に柔軟性を持たせるための準備段階の実装変更が行われています(主にアトリビュートのリストの定義クラスなどが変更になっています)。
  • (Ver.1.5.1以降)インポート時にセルの大きさを調整して、透明色領域を極力減らして描画量を下げるオプションを追加しました。ただし、本オプションを使用すると「UV関係」「カラーブレンド」のアトリビュート・「エフェクト機能」の描画・「ランタイムでのマテリアルのテクスチャを変更」などの際に、期待しない動作を行うことがありますのでご注意下さい(セルやスプライトパーツの大きさがSS5上のデータと異なってしまうためです)。
  • (Ver.1.5.11以降)「インスタンス」アニメーションと親アニメーションとのフレーム同期が、過去バージョンと比べて厳格になっています。過去バージョンの、インポート時やPrefabの実体化の状況いかんで、「インスタンス」側が1実行サイクル分反映が遅れる場合がある症状が解消されています。
  • (予定)できるだけ早いタイミングで、(従来対応していた優先度に加えて)Z座標での優先度設定のアニメーションデータのインポートに対応する予定です。

Ver.1.4.xからVer.1.5.0への移行へは、データの再インポートが必要となりますので、Ver.1.4.xでインポートしたデータをそのままご使用される場合、Ver.1.5.0に移行せずにVer.1.4.11以降のVer.1.4系をご使用ください
※動作面やスクリプトの仕様的にはVer.1.4.xからの線形バージョンアップになっていますが、データの格納形式が変更になりPrefabの互換性がなくなるため、マイナーバージョン間での混乱を避けるため、ミドルナンバーを上げてのバージョンアップとなります。
※Ver.1.4系もVer.1.4.11を安定版とした後も、しばらくの間(Ver.1.5系と平行して)バグ改修等のサポートは続ける予定です。

※また今後、Ver.1.5.0以降のどこかのタイミングで、Unity3.5系及びUnity4系への対応を終了し、Unity5以降への対応に移行することを考えております。現状、時期やバージョンは未定です。
現在、Ver.1.6.0がその(Unity3.5系・Unity4系のサポートが終了する)タイミングであると想定しています。
その際には前もって当ページなどでアナウンスいたしますので、何卒ご理解の程お願い申し上げます。
※本SS5Player for Unityの対応バージョンと今後の予定については、上記「Unityの対応バージョンの変更について」のアナウンスの内容となります。

バージョン1.4.x概要

SS5Player for Unityの本バージョンは、先までのVer.1.3系と比較して下記の点の仕様が変更されております。

  • SpriteStudio5.7で刷新された「エフェクト」機能に対応しています。SpriteStudio5.6以前のエフェクト機能には対応していませんので、ご注意ください(またVer.1.3でインポートしたエフェクトデータの再生にも対応しておりません)。
  • エフェクト機能以外の面では、Ver.1.3.xからの線形更新(上位互換更新)です。
  • SpriteStudio5.7での「エフェクト」機能の刷新に伴い、エフェクトを含んだデータの逆再生などが可能になりました。
  • エフェクトの逆再生などが可能になったことから、インスタンス機能の内部処理も見直し、より再現性が向上しております。
  • Ver.1.3.xではシーン上の「インスタンス」アニメーションの実体を都度再生成する仕様を改定しました(同時にアニメーション再生中の「インスタンス」の差し替えなども行えるようになりました)。
  • 描画マネージャ(Script_SpriteStudio_ManagerDraw)に「描画反映を1メインループ遅延させる」オプションがつきました(他の描画アセット等との同期時の描画反映のタイミングのずれを解消する目的の機能)。
  • アニメーションのセルを実行時に変更する機能を追加しました(Ver.1.4.3以降)。

※SpriteStudio5.7でのエフェクト機能の刷新に伴い、SpriteStudio5.6以前のエフェクト機能を使用しているデータを再インポートする際には、SpriteStudio5.7上でデータの挙動を再確認及び再保存してから、SS5PU Ver.1.4.xで再インポートして頂けますようお願い申し上げます。

Ver.1.3の詳細内容については、直下の「バージョン1.3.x概要」をご参照ください。

バージョン1.3.x概要

SS5Player for UnityのVer.1.3.xは、先までのVer.1.2系と比較して下記の点の仕様が変更されております。

  • SpriteStudio5.5以降で搭載した、「エフェクト」機能に対応しています。
  • 今後の機能拡張や改良などを勘案し、「SS5Player for Unity」の仕様を再設計し・プログラムのほぼ全てを新造しなおしました。
  • プレーヤーの動作速度を向上させ、MonoBehaviourの使用を最低限にしました。そのためVer.1.2系と比較して、(動作プラットフォームやアニメーションデータによって効果は上下しますが)約1.5倍~5倍程度の高速化が期待できる場合があります。
  • データサイズを縮小・プレーヤーの動的ワークエリア(都度newされるワークエリアなど)の極力廃止で、使用メモリ量やガベージコレクト回数の減少などが期待できます。特に静的アニメーションデータ量は「圧縮しておく方が都合の良い一部アトリビュート」などについては圧縮オプションの有無に関わらず常に圧縮された状態になるため、全体的にデータサイズは縮小しています。
  • セルマップのデータを保持するようにしました。Ver.1.2系まではセルマップのデータはアニメーションデータに変換され・未使用のセル情報などは消失していましたが、Ver.1.3系ではSpriteStudio5上で設定されている全セルのデータがランタイム用に保持される仕様になっております。
  • シーンデータ構築の際の柔軟性を改善しました。特にカメラ・ビュー(描画マネージャ)・再生アニメーションが親子関係になっていなくても、シーンを構築できるようになりました。
  • シーンデータ構築の柔軟性向上に伴い、描画マネージャに存在した「RenderQueue」の動作を廃止しました(RenderQueue機能を使用せず、カメラのレイヤー及びDepthや描画マネージャのTransformのZ値などで管理する形に変更になりました)。

Ver.1.2系を使用している既存プロジェクトへVer.1.3を適用する場合は、組み込みの改修(全データの再インポートやスクリプトの変更など)などプロジェクト全体の動作検証も行う時間が発生すると思われますので、その点も考慮いただきますようお願いいたします。
何らかの都合によってprefabファイルのフォーマットや制御側のプログラム(スクリプト)を変更できない場合は、Ver.1.2系(現行最終バージョン1.2.32)からアップデートを行わずに・Ver.1.2系のまま使用することをも検討してくださいますようお願い申し上げます。

今後の拡張や最適化を考慮しましてバージョン1.2系から大きく構成を変える事といたしました。
これにより1.2系に無かった不具合が発生する事が考えられます。
bata1ではエフェクト再現が完全でない部分があります。現在対応中ですのでご了承の上ご使用ください。
こちらは随時対応していきたいと考えておりますので使用方法等のご質問も含めまして、Issueの方に投稿をしていただけると助かります。
投稿方法についてはページの下部にあります質問、不具合、要望を投稿する方法を参照してください。

データのインポート手順

【Ver.5.8】Unityにアニメーションを表示する | OPTPiX Help Center
各機能の詳細はこちらを参照してください。

アニメーションの再生

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

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

サンプルプログラム

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

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

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

お問い合わせ

まずこちらのリンクからIssuesページを開き過去に投稿されたFAQをご確認ください。

Issuesページの質問だけ表示する場合はこちら
Issuesページの不具合だけ表示する場合はこちら
Issuesページの要望だけ表示する場合はこちら
同じ内容の質問があった場合、何か追加情報がある場合はコメントに書いて下さい。

質問、不具合、要望を投稿する方法

  • 投稿前に必ずお読みください

    • (重要)投稿した内容について
      投稿した内容は全て一般に公開されますので個人情報や機密情報を記載しないようにご注意ください。
    • 質問をIssueへの書き込むにはGitHubのアカウントが必要です。
      アカウントをお持ちでない場合、こちらのGitHubチュートリアルを参考にアカウントを作成してください。
    • 別のプレイヤー、別のツールの質問はそれぞれのページへ投稿してください。
  • 投稿する
    Title欄に先頭にバージョン番号をvX.X.Xとつけて概要を記入し、Leave a comment に詳細を記入します。
    [Submit new issue] ボタンを押して完了です。後ほど担当者が確認しコメントいたします。

  • 再現データの添付が必要な場合

    • ウェブテクノロジの専用メールアドレス github-spritestudio@webtech.co.jp に添付して送付してください。
  • クリックするとメーラーが起動します。

  • ※送信する前に宛先が上記アドレスと相違ないかご確認ください。

  • ※重要なデータを含んでいる場合は、.zip を暗号化し、パスワードは別途お知らせください。

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

SpriteStudioArchiveをご参照ください。

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

株式会社ウェブテクノロジ
http://www.webtech.co.jp/
Copyright(C) Web Technology Corp.

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

  • SpriteStudio, Web Technologyは、株式会社ウェブテクノロジの登録商標です。
  • その他の商品名は各社の登録商標または商標です。
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.