Skip to content
SpriteStudio edited this page Oct 4, 2021 · 152 revisions

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

SpriteStudio 5 SDK v1.7.1

Copyright © CRI Middleware Co., Ltd.

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

本SDKは、OPTPiX SpriteStudio 5で製作されたデータ(sspj,ssce,ssae,ssee)をユーザーの皆様の再生環境に応じて柔軟にご利用いただくためのライブラリ、およびツール群で構成されます。

  • sspjLib :SpriteStudioのプロジェクトファイルsspjを解析するためのライブラリです。

    • ローダー:SpriteStudio 5 形式のファイル(sspj,ssce,ssae,ssee)の読み込みモジュール
    • アニメータ:座標変換、補間計算などを行うアニメーションモジュール
    • ドローワー:OpenGL を利用した描画モジュール ※DirectX 版は現在対応中です
  • Tools:ライブラリを使用して作成されたツールです。

  • ビューアー:Windows/Mac 用ビューアーサンプル

  • コンバータ:sspjファイルから汎用バイナリファイルssbpへ変換します。

  • コンバータの取得はこちらから

  • 想定している用途
    本SDKの用途としては、sspjを解析して新たなプラットフォーム用プレイヤーを作成する、必要な形にデータを加工するツールの作成となります。
    ゲームやアプリで使用する場合は、アニメーション制御に特化したプレイヤープログラムを公開しております。
    またアニメーション編集に役立つ外部ツールも公開していますので、以下のリンクを参照してみてください。

  • 免責事項
    本ソフトウェアは評価版であり、動作検証、評価を目的として配布しているため、
    何らかの不具合が含まれている可能性があることをご了承いただいた上で、
    ご利用いただきますようお願い致します。

対応するSpriteStudioのバージョンについて

SpriteStudio5 SDK Ver1.7.0はSpriteStudio5.7.0に対応しております。 エフェクトの挙動がSpriteStudio5.7.0と同等になります。 SDKをアップデートする場合、SpriteStudio5.7.0でエフェクトの挙動を確認、調整して使用してください。

SS5PlayerとSpriteStudioSDKの互換性について

SpriteStudioSDKに付属されているSs5converterで出力するssbpファイルにはフォーマットバージョンが存在します。
フォーマットバージョンの一覧はこちら
SS5Player(ForCocos2d-x、ssbplib)の対応しているフォーマットバージョンを確認し、対応したSs5converterを使用してください。
フォーマットバージョンが異なる場合ssbpファイル読み込み時にエラーとなります。
プロジェクトの都合などでssbpファイルのフォーマットを変更できない場合は動作している組み合わせを継続して使用する事を検討してください。

SDKのビルド方法について

SDKのビルド方法を参照してください。

リファレンス

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

ブランチ について

SpriteStudioSDKにはmasterとdevelopがあり、プレイヤーを含む最新のコードはdevelopにコミットされます。
安定版と判断した段階で、developからmasterへマージしてバージョンをつけています。
現在のmasterに存在する不具合の修正はdevelopに反映されますので、不具合か判断が難しい場合はdevelopブランチのログを確認してみてください。

Pull Request について

Pull Request は大歓迎です!
リクエスト送信前にIssue化しておく必要はありません。
変更内容はコミット時のコメントに記入していただければ十分です。

使用しているオープンソースライブラリについて

このサンプル、SDKでは以下のライブラリを使用しています。
各ライブラリのライセンス等につきましては、下記ページよりご確認ください。

ローダー部分

レンダラー

サンプルのGUI部分

ご好意で提供していただいたプログラムを公開しています。
ご使用の前にこちらをお読みください。SpriteStudio 5 3rdPartys

  • Ss5Converter For Unity2D:sspjをUnity2D形式のアニメーションにするコンバータです。
  • SS5ViewerDirectX:sspjを読み込みDirectXで表示するサンプルプログラムです。
  • SpriteStudioPlayerForUGUI:sspjをUnityのUGUIアセット形式でアニメーションさせるプレイヤーです。
  • DxBase2015フレームワーク:3Dゲーム作成が可能なフレームワークです。SpriteStudioのアニメーションを再生する機能も備わっています。
  • SpriteStudioForUnity:SpriteStudioのアニメーションをUnity4以降に搭載されたMecanimを使用して再生するプレイヤーです。
  • SSPlayerForRPGMV:SpriteStudioのアニメーションをRPGツクールMV上で使用するためのプラグインです。

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

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

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

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

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

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

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

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

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

株式会社CRI・ミドルウェア
https://www.cri-mw.co.jp/
Copyright © CRI Middleware Co., Ltd.

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

  • SpriteStudio, Web Technologyは、株式会社ウェブテクノロジの登録商標です。
  • その他の商品名は各社の登録商標または商標です。