【ツクールMV】自作プラグインを作ろう!
閉じる
閉じる

新しい記事を投稿しました。シェアして読者に伝えましょう

×

【ツクールMV】自作プラグインを作ろう!

2019-09-12 01:45
    皆さんこんにちは。青いペンギンこと荒上理紗斗(あらがみ りさと)です!


    今回は、RPGツクールMVでゲームを作るうえで切っても切れない存在ともいえるプラグインについて書いていこうと思います。

    (内容としては、「たまに「スクリプト」を使うくらいにはJavaScriptが分かる」くらいの中級者向けの記事となります)

    -----

    以前書いた「ツクールMVの内部データをしゃぶりつくす」回でも若干言及しましたが、スクリプト化およびプラグイン化の目的としては

    ・イベントコマンドだと冗長になってしまう処理を簡潔に書く
    ・そもそもイベントコマンドではできないことを書く
    ・イベントコマンドでは取れない(もしくは取りにくい)ような内部の数値データを利用する

    と言いました。

    これらの目的はもちろんのこと、プラグイン化にはもうひとつ目的があります
    それは、ゲームファイルの壁を越えて、よく使う機能をまとめておける(ブックマーク登録のように)ことです。
    ある程度JavaScriptが分かる方なら、それぞれのプラグインをひとつの関数のように扱う、という表現をすれば分かりやすいと思います。

    自分がよく使う機能をまとめておいて、それを呼び出しやすくできるだけでも相当ストレスフリーなので、皆さんもぜひ挑戦してみてください!

    -----

    では、実際に作業に取り掛かってみましょう!

    ここからは実際にJavaScriptを書く段階に移るので、プログラミング用のエディタがあると作業が楽です。
    なくても「メモ帳」などを用いればできますが、あった方が圧倒的に楽なので、お持ちでない方は無料のエディタをDLすることをオススメします!

    【エディタがない方向けの補足】
    荒上理紗斗が普段使っているエディタ「Atom」(無料)→ 公式サイトはこちら
    Microsoft社が公開しているエディタ「VSCode」(無料)→ 公式サイトはこちら

    エディタを既に導入済みの方は、普段お使いのエディタを用意すればOK!

    -----

    まずは、プラグインを導入したいツクールMVのプロジェクトがあるフォルダを開きます。
    ツクールの画面の「ゲーム」→「フォルダを開く」を選択!


    そうするとフォルダを開けますので、そこにある「js」フォルダを右クリックします。
    すると、このような「エディタで開く」コマンドがあると思いますので、それを選択。

    (補足:私はAtom派なので「Open with Atom」ですが、VSCodeの方は下の画像の「Open with Atom」のひとつ上にある「Visual Studio で開く」を選択してください)

    もしそのコマンドがなければ、当該ファイルをエディタにある「ファイル」→「フォルダを開く」的なコマンドから呼び出してください。


    開いたらここからはエディタ内での作業になります。
    次は自作プラグイン用の新規ファイルを立ち上げたのち、「plugins」の中にある「ItemBook」を開いてください。
    このプラグインにお世話になったことがある方も多いのではないでしょうか。

    このプラグインの38行目(下の画像に写っているところ)までをコピーして、自作プラグイン用の新規ファイルにペーストしてください。
    この38行目までは、そのJavaScriptファイルをツクールMVのプラグインとして使えるようにするための設定フォームのようなものです。


    コピペしたら、次はこのテンプレートを参考に自作プラグインに沿った設定に書き換えます。

    まずはプラグイン名。目的に合った名前にしましょう。
    今回は特に目的があるわけじゃないので「BluePenguin.js」にしました。


    次は、MVのプラグイン一覧画面でタイトルの横に出る簡易説明を書きます。
    今回は「青いペンギン用のプラグイン」とでもしておきます。


    次は作者名。自分のペンネームを書いておきましょう。
    ただし、「編集可の他作プラグインを編集した際に、作者名に自分の名前を書いていいのか」については、制作者様の定められた規約に従ってください。これ大事。


    次はプラグインパラメータです。
    パラメータ関連は少し難しいのと、必ずしも必要ではないので、一旦飛ばします。
    後ほどまた書き方などについて言及します。

    とりあえず今は削除してしまいましょう。


    とうとう設定関連の最後のプロセス。プラグインヘルプを編集します。
    もしプラグインコマンドを利用する場合は、このヘルプ欄にコマンドのまとめを書いておくと便利です。(ツクールMVのイベント編集のプラグインコマンド入力画面でF1を押すと、ここ入力したヘルプが見れるため)

    もしコマンドがない場合は、下の画像のように無い旨を書いておきましょう。
    ちなみにパラメータと同じく、後ほど書き方についても言及します。


    これで設定関連は完成!
    区切りが良いので、一旦データを保存しましょう。

    最初に決めたプラグインのタイトル(今回の例では「BluePenguin.js」)をコピーして、それをそのままファイル名にしてしまいましょう。
    保存場所はもちろん「js」フォルダの中にある「plugins」フォルダの中です!


    -----

    では、ここからは実際に処理をしてくれるコード本体を書いていきます。

    まずはこちら。
    なんのこっちゃ?と思う方もいるかもしれません。
    詳しい説明は割愛しますが、プラグインを書く際のお約束のようなものだと思っていただければOK!
    (気になる場合は「即時関数」で検索!)


    あとは、今書いたカッコの中にプラグイン化したい処理を書けば完成


    -----

    これさえできれば、最低限プラグインとしての体は保てているので、あとは自由にコードを書いていくだけなんですが、もっと使い勝手を良くしたいですよね。

    そう。先ほど後回しにしたパラメータとプラグインコマンドです!
    こいつらを使いこなせると、よりプラグインを使いやすくなりますので、それについても解説していこうと思います。

    ただ、現時点で結構長くなってしまったので、一旦ここで切って、続きは次の記事でやろうと思います。

    続きはこちら!

    広告
    コメントを書く
    コメントをするには、
    ログインして下さい。