/ChangeCharacterToSS

Replace the actors or events' character animation patterns to animation made by OPTPiX SpriteStudio.

Primary LanguageJavaScriptMIT LicenseMIT

ChangeCharacterToSS

アクターやイベントのアニメーショングラフィックをSpriteStudioのアニメーションに置きかえるプラグインです。

** English document is under construction. **

注意

本プラグインの動作には、依存プラグイン「SsPlayerForRPGMV」が必要です。下のURLからダウンロードの上、 本プラグインより上の位置にインストールしてください。
https://github.com/InabaByakko/SSPlayerForRPGMV

このソフトウェアは、MITライセンスのもとで公開されています。詳しくは LICENSE.md をお読み下さい。

デモ

https://inababyakko.github.io/ChangeCharacterToSS/SampleProject/index.html

SampleProject フォルダに上記デモのプロジェクトデータが格納されています。

起動時のSpriteStudioロゴの表示には、SmallOmega様の"BootOpeningDemo"プラグインを使用させていただきました。
http://smallomega.com/

動作環境

SpriteStudio Starter/Professional (バージョン6) で自作アニメーションを作成する場合

このプラグインは、SpriteStudio バージョン5 のプロジェクトデータにのみ対応しており、SpriteStudio Starter (バージョン6) で作成されたデータのうち、新機能であるメッシュ・ボーン・デフォームの機能を使用したアニメーションは再生できません。

また、JSONファイル変換ツール Ss5ConverterToSSAJSON を使用する前に、プロジェクトをバージョン「5.8」形式でエクスポートしてから、変換を実行して下さい。

image image

使い方

プロジェクトへの組込み

  1. 右部の「Download ZIP」をクリックし、最新版のZIPアーカイブをダウンロードします。

  2. ダウンロードしたZIPファイルを解凍して出てきた ChangeCharacterToSS.js を、組み込みたいゲームプロジェクトのjs/pluginsフォルダへ入れます。

  3. ツクールエディタの「プラグイン管理」より「ChangeCharacterToSS」を追加します。

データ作成

  1. SpriteStudioのエディタにて、以下の名前を末尾に含むモーションを作成してください。
    • idle (キャラクターが停止しているときのモーション)
    • walk (キャラクターが移動しているときのモーション)
    • dash (キャラクターがダッシュしているときのモーション:プラグインパラメータで使用しないよう変更できます)
      • ssaeファイル名は任意のもので構いません。また、モーションによってssaeファイルが異なるものになっても問題ありません。
      • モーション名はプラグインパラメータで変更することができます。
  2. キャラクターの向きに応じてモーションを変更したい場合は、向かせる方向分のモーションをさらに作成し、モーション名の末尾に _left / _right / _up / _down を付加してください。
    • 例) 右向きの歩行モーションの場合、 walk_right という名前でモーションを作成
  3. 他に使用したいモーションがある場合は、任意の名前で作成します。
    • こちらもキャラクターの方向に対応するモーション名をつけることで、異なるモーションを再生できます。
  4. Ss5ConverterToSSAJSON を用いてJSONファイルに出力してください。
    • 「1モーションを1ファイルで出力する」にはチェックを入れないでください
  5. SsPlayerForRPGMV で指定された所定のフォルダに、出力したJSONファイルとパーツ画像ファイルを格納してください。

アニメーションのサンプルプロジェクトを SampleAnimation フォルダに格納しています。参考にどうぞ。
(このデータはSpriteStudio公式サンプルデータ「基本的なアニメーションのサンプル」を利用し、一部改変を加えたものです。利用条件などは、SampleAnimationフォルダ中のreadme.txtをお読みください。)

データベース設定

設定したいアクターのメモ欄、またはイベントページの「注釈」コマンド中に、以下のようなタグを入れる

<SSCharName: 読み込みたいアニメーションJSONファイル名(.jsonは抜く)>
または
<SSキャラ名: 読み込みたいアニメーションJSONファイル名(.jsonは抜く)>

途中でアニメーションやモーションを変更したい場合

イベントコマンド「移動ルートの変更」中にて特定のスクリプトを実行することで、プレイヤーまたは指定したイベントのアニメーションやモーションを変更することができます。
詳しくは、プラグインヘルプをご覧ください。

([ツール]->[プラグイン管理]からChangeCharacterToSSを選択し[ヘルプ]、またはスクリプト入力ダイアログで右クリック->[プラグインヘルプ]->ChangeCharacterToSSを選択)

動作確認済みのサードパーティプラグイン

本プラグインは、以下のキャラクターまわりの処理に影響を与えるサードパーティプラグインを導入した際の動作検証を行っておりますが、 その他のプラグインとの競合が発生する場合があります。あらかじめご容赦ください。

動作確認が取れ次第、順次追加されます。

バグを見つけた場合

ご迷惑をお掛けしております。もし問題のある動作を発見された場合は、GithubのIssueでトピックを立ててご報告いただくか、Twitter@InabaByakkoまでご連絡をお願い致します。

Githubのご利用に慣れていらっしゃる方は、直接のPull Requestも歓迎しております。


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