プラグイン利用入門

プラグインの導入

用意するもの

テキストエディタ(必須ではありませんが、あるとなにかと便利です)
Webブラウザ(Google ChromeなどのWeb閲覧に使用するブラウザです)

プラグインのダウンロード

プラグインは公式が提供するもの、個人が提供、販売するものなどがありますが、まず対象のJSファイルを入手するところから始めます。

JSファイルをインターネット経由で入手する場合、ブラウザごとの一般的な方法に従ってダウンロードしてください。ファイル名は特別な指示がない限り、変更しないでください。

具体的な配布方法は作者によって異なります。GitHubで配布しているケース、Dropboxなどに置いているケース、JSファイル単位で配布しているケース、圧縮しているケース、サンプルプロジェクトとして配布しているケースなど、様々です。

ダウンロードしたファイルをテキストエディタで開いてみましょう。文字化けしている場合、正常にダウンロードできていない場合があります。

ライセンス(利用規約)の確認

プラグインの利用を始める前にライセンスや利用規約の確認をします。
多くの場合、配布元のWebサイトやJSファイルの中、あるいは付属のReadMeなどに記載されています。
大半のライセンスには『やっていいこと』『やってはいけないこと』が明記されています。

プラグイン管理画面の見方

まずJSファイルをプロジェクトの『js/plugins/』配下に配置します。
そしてMZのエディタから、プラグイン管理(F10)を開きます。下記のボタンでもOKです。

すると既に適用しているプラグインが一覧に表示されます。
MZの変更点として一覧の左にチェックボックスが追加され、ON/OFFを簡単に切り替えられるようになりました。

さらに画面下に『警告メッセージ』が表示されるようになりました。警告メッセージとは、このままゲームを開始するとプラグインが正常に動作しない可能性が高い場合に表示されるメッセージのことです。

警告の種類

警告メッセージには以下の種類があり、それぞれ対応が必要です。

プラグイン「AAA」は、RPGツクールMZに対応していない可能性があります。

前作MV向けに作成されたプラグインを使おうとした場合などに発生します。

プラグイン「AAA」には、ベースプラグイン「BBB」が必要です。

前提となるベースプラグインが適用されていない場合に発生します。
ヘルプなどを参考にベースプラグインを導入すれば解決します。

プラグイン「AAA」は、プラグイン「BBB」の前に配置しなければいけません。
プラグイン「AAA」は、プラグイン「BBB」の後に配置しなければいけません。

競合回避などを理由にプラグインの適用順序を指定される場合があります。
メッセージに従って順序を入れ替えれば解決します。

プラグイン「AAA」は、重複して登録されています。

管理画面で同一のプラグインを二つ以上登録してかつONになっていると発生します。
複数登録する意味はないので、片方を削除すれば解決します。

プラグイン「AAA」がロードできません。

管理画面からプラグインを登録した後で、ファイル自体を削除した場合などに発生します。
このまま実行するとロードエラーになるので一覧から削除するか、ファイルを復元すれば解決します。