プラグイン内部記述の基本知識
コメントについて
「コメント」はJavaScriptの中でプログラムとして実行されない文です。
一般的にコードの説明などを記述しておくメモのような位置づけです。
コメントの書き方には二種類あります。
- 「//」を行頭に入れる。
- 「/*」「*/」で単数行/複数行を囲う。
RPGツクールMVヘルプ「プラグイン仕様」より引用
エディター側に表示されるプラグインの説明とパラメータは、“/*:”で始まるコメント内で指定します。
説明とパラメーターの記載
「/*:」「*/」で囲われた部分が、プラグインの説明とパラメーターが記載されています。
以下は代表的な例です。
/*:
* @plugindesc プラグインの説明。
* @author プラグインの作者。
* @param パラメータの名前。
* @desc パラメータの説明。
* @default パラメータのデフォルト値。
* @help
* ヘルプ文章
* :
*/
この部分を英語から日本語へ表示を変換するテキストをパッチと読んでいます。
作業に必要なソフト
UTF-8が扱えるテキストエディタが必要です。
自分はWindowsでサクラエディタを使用しています。
sakura-editor.github.io/
Mac等の方は好みのエディタを探してください。
日本語化パッチをコピー＆ペースト
パッチを当てる前のプラグインはバックアップとして保存してください。
当サイトでは、日本語化パッチ部分をダウンロードファイル以外にも記事内に記載しています。
YEPシリーズには、まだパッチファイルの準備ができていないので、各記事から日本語化パッチ部分をコピーしてください。
貼り付ける先はヘルプとパラーメーターが終わった後の「*/」の次の行です。
▼貼り付け前
▼貼付け後
貼付け後に、必ず「UTF-8形式」で保存してください。
文字化け対策
英語のプラグインを開くとEUC形式等になっているファイルが時々あります。
これに日本語化パッチを貼った後に上書きで保存しただけだと、ツクール上で文字化けして表示される場合があります。
文字化けしてしまった場合、下記を試みてください。
- バックアップから作業をやり直す。
- 貼り付けたプラグインファイルをテキストエディタで文字化けしない状態で開き、UTF-8で保存し直す（「名前を付けて保存…」等で設定し直して上書き）。
