DynamicAnimation&Motionの定義をtxtから読み込む【RPGツクールMZ&MVプラグイン】

2024年12月25日

 DynamicAnimation&Motionの定義をtxtファイルから読み込みます。

 スキルのメモ欄に以下を記載すれば、指定のフォルダにあるtxtファイルから定義を読み込みます。
<D-Txt:[ファイル名]>

 ※ファイル名に拡張子は不要です。
 ※初期値では『[プロジェクト]/data/D-Txt/』がフォルダになります。フォルダを作成してtxtを配置してください。プラグインパラメータから変更可能です。


 例えば、<D-Txt:abc>ならば、abc.txtを参照します。
 また、ファイル名を省略するとスキルIDを自動でファイル名に使用します。
 例えば、スキルID=100ならば、100.txtを参照します。

 テストモード時はスキルを使用する度に毎回ファイルを読み込みます。これにより、ゲームを停止することなく動作を繰り返し確認できます。
 ※本番モード時は起動時に全ての定義を読み込みます。


 上記のようにウィンドウを並べながら編集すれば超便利です。

 ver1.03より、動作を単純な置換方式に変更しました。これにより一つのスキルを複数のテキストで構成したり、詠唱やカットインなどの共通処理だけを置き換えることが可能になりました。

 [記述例]
<D-Txt:spellStart>
<D-Animation/>
<D-Txt:spellEnd>


目次


導入方法(Install)

更新履歴(History)

暗号化について(About Encryption) ver2.00

注意点(Caution)

日本語読込について

他プラグインとの連携

ブラウザ実行時

プラグインパラメータ(PluginParameter)

txt配置フォルダ(ReadTxtFolder)

暗号化を使用(UseEncrypt) ver2.00

暗号化出力フォルダ(EncryptFolder) ver2.00

テスト時は毎回読込(DynamicReadOnTest)

本番モードで実行(ProductionMode) ver2.00

ブラウザモードで実行(BrowserMode) ver1.04


導入方法(Install)


 以下のファイルをダウンロードし 、[プロジェクト]\js\plugins に放り込みます。ツクールのプラグイン管理から機能をONにしてください。
 ※このプラグインはMV、MZの両方で有効です。

 NRP_DynamicReadTxt.js ver2.001(2024/12/25)

 さらに以下のプラグインを最新に更新してください。
 ※バージョンに食い違いがあると動作しない可能性があります。

MZ用

 NRP_DynamicAnimationMZ.js ver1.081(2020/10/20)
 NRP_DynamicAnimationMapMZ.js ver1.071(2020/10/19)
 NRP_DynamicMotionMZ.js ver1.06(2020/10/17)

MV用

 NRP_DynamicAnimation.js ver1.181(2020/10/20)
 NRP_DynamicAnimationMap.js ver1.072(2020/10/20)
 NRP_DynamicMotion.js ver1.13(2020/10/17)

 ※上記プラグインよりも、当プラグインは下に配置してください。

更新履歴(History)


2024/12/24 -> 2024/12/25(ver2.00 -> 2.001)


2021/03/04(ver1.06)

  • MZ ver1.2.0にて、起動時に強制終了する問題に対応。

2020/12/13(ver1.05)

  • MVの本番実行時、フォルダ参照エラーとなる不具合修正。

2020/11/22(ver1.04 -> 1.041)

  • アツマールなどのブラウザ実行でエラーになる不具合に対応。
    ※テスト実行時にブラウザ実行用の必要ファイルを生成します。更新を適用後、一度テスト実行してください。
  • 不要なログ出力を削除。(ver1.041)

2020/10/20 -> 10/21(ver1.03 -> 1.032)

  • <D-Txt>の動作を単純な置換方式に変更。
    一つのスキルを複数のテキストで構成したり、詠唱やカットインなどの共通処理だけを置き換えることが可能になりました。
  • ウェイトなしのアニメをテスト読み込みできない不具合修正。(10/21 ver1.032)

2020/10/20(ver1.02)

  • マップ版DynamicAnimationのステートからの起動(<D-Skill>)にも対応。
  • 途中セーブからの開始時、エラーになってしまう不具合修正。

2020/10/15(ver1.01)

  • マップ版DynamicAnimationの自動起動(<D-Skill>)で毎回読込が有効にならない不具合修正。

2020/10/07(ver1.00)

  • 公開!

暗号化について(About Encryption)


 本プラグインは暗号化に対応しています。
 txtファイルを暗号化し、本番用にデプロイメントした際には中身を読めないようにすることができます。

 ただし、暗号化の強度は気休め程度なのでご了承ください。
 txtを開くだけで中身が分かるという状況は避けられます。


手順

 1.『txt配置フォルダ』にプロジェクト外のフォルダを指定する。
例:C:/D-Txt/

 ※必ず『\』ではなく『/』にしてください。
 ※末尾にも『/』は必須です。
 ※配置はどこでもよいですが、プラグインの設定は本番にも残ります。パス名に個人情報を含まないように注意してください。


 2.『暗号化を使用』をオンにして、テストプレイを実行する。
 ※『暗号化出力フォルダ』は初期設定でも問題ありません。

 テストプレイ開始時に『暗号化出力フォルダ』へと暗号化されたファイルが作成されるようになります。
 後はそのままデプロイメントすればOKです。

 ファイルの数が多かったり、PCのスペックが低かったりすると、暗号化に時間がかかってしまいます。
 『暗号化を使用』は普段の開発時はオフにしても問題ありません。

注意点(Caution)


日本語読込について

 当プラグインで扱うテキストファイルの文字コードはUTF-8を推奨します。Shift_JISなどになっていると、日本語が読み込めないようです。
 例えば、playSe(効果音)で日本語ファイル名を指定した場合にエラーとなってしまいます。


 大抵のテキストエディタならば、名前を付けて保存時に文字コード(エンコード)が指定できます。

他プラグインとの連携

 当プラグインはあくまで『DynamicAnimation&Motionの定義をtxtファイルから読み込む』プラグインです。
 そのため、Dynamic系プラグイン以外のメモ欄の記述をテキスト内に書き出しても機能しません。勢い余って全てを書き出さないように注意してください。要するに『D-』から始まる以外の記述が含まれていたら、大体アウトです。

 特に合体技プラグインの事故率が高いです。
 ちなみに、他プラグインの定義と組み合わせる場合は以下のように記述します。
<CS_Actors:1,2>
<D-Txt>


ブラウザ実行時

 ゲーム起動時に全てのtxtファイルを読み込む仕様のため、大量&大容量のtxtファイルがあると起動速度に影響を与える可能性があります。
 単なるテキストファイルなので、そうそう大したことにはならないと思いますが一応……。

 ver1.04より、テスト起動時に『FILE_LIST.txt』というファイルを『txt配置フォルダ』に作成するようになりました。
 これはRPGアツマールなどのブラウザ起動時に、読込対象となるファイル一覧を取得するためのファイルです。
 そのため、各txtのファイル名変更後、一度もテスト起動せず、本番ファイルをアップロードした場合、正常に動作しません。
 まずありえないと思いますが、一応ご注意ください。

プラグインパラメータ(PluginParameter)


txt配置フォルダ(ReadTxtFolder)

 読み込む.txtファイルを配置するフォルダです。
 初期設定は"data/D-Txt/"です。

 暗号化を使用する場合は、プロジェクト外を指定してください。
例:C:/D-Txt/


暗号化を使用(UseEncrypt)ver2.00

 txtファイルを暗号化し、暗号化出力フォルダへと出力します。

暗号化出力フォルダ(EncryptFolder)ver2.00

 暗号化したtxtファイルを配置するフォルダです。
 初期設定は"data/D-Txt-Encrypt/"です。

テスト時は毎回読込(DynamicReadOnTest)

 テスト時はスキルを使用する度に読込を行います。
 これによりゲームを停止せずに動作変更が可能となります。
 ※この機能は本番だと自動的に無効となります。

本番モードで実行(ProductionMode)ver2.00

 強制的に本番モードの挙動で実行します。
 ※デバッグ用の項目なので普段はオフ推奨です。

 本番モードではファイルを起動時に全て読み込むようになります。
 また『暗号化を使用』とセットでオンにすると、暗号化されたファイルを読み込むようになります。動作速度の検証などにご利用ください。

ブラウザモードで実行(BrowserMode)ver1.04

 強制的にブラウザモードの挙動で実行します。
 ※デバッグ用の項目なので普段はオフ推奨です。
 ※ブラウザモードと暗号化を併用した際の挙動は未検証です。

 >RPGツクールMZ&MV目次に戻る
posted by 砂川赳 at 11:16 | RPGツクールMZ&MV | このブログの読者になる | 更新情報をチェックする