アドオン開発テンプレートの使い方
この記事では、アドオン開発用に必要な開発環境の設定をします。
ここで設定するアプリ・ソフトはプロが実際の現場で使っているものと、まったく同じです。 これらの使い方を覚えておくと、実際の開発現場でも役立ちます。
PCの初回設定
プログラミング用エディターのインストール
プログラミングを始めるには専用のエディターが必要です。 インストールがまだの方は、次の記事を参考にエディターをインストールしてください。
Node.jsのインストール
アドオン制作を簡単に行うためのツール(npm)の導入をするためにNode.jsをインストールします。
特別な理由がない限りは、LTSバージョンの方をダウンロード・インストールしておきましょう。
LTSとはLong-Term Supportの略で、長期サポート版のことです。 今回の目的では、バグがあるかもしれない最新版よりも、少し古くても安定してるバージョンの方が最適です。 （最新版でもまず問題は起こりませんが）
gulpCLIをインストール
「gulp」とは一連の操作を自動で実行するためのツールです。
コマンドラインを開き、次のコマンドを実行してgulpコマンドを実行できるようにします。
npm install gulp-cli --global
プロジェクトの初回設定
1. テンプレートをダウンロードして展開する
次のリンクからテンプレートをダウンロードしてください。（公式ドキュメントを参考にして、筆者が独自に作成したテンプレートです。）
画面上方の緑色の「Code」ボタンから、「Download ZIP」を選択することで、ダウンロードできます。
ダウンロードしたZipファイルを展開してください。
展開したプロジェクトフォルダーはどこに置いても構いません。 あとで移動させることもできます。
2. プロジェクトフォルダーをVS Codeで開く
プロジェクトを開いたとき、推奨拡張機能が表示されるので、同時にインストールしておくと便利です。 必須ではありません。
3. npmパッケージをインストールする
展開したフォルダーをVS Codeで開きます。
この時README.mdがプロジェクトの最上位にあるか確認してください。
階層が重要なので、余計なフォルダーが間に挟まっていたりする場合は開きなおしましょう。
正しい階層であれば、その状態でVS Codeのターミナル（コマンドラインを実行する場所）を開きます。(Ctrl + Shift + @)
次のコマンドでnpmパッケージをプロジェクトにインストールします。 （プロジェクトフォルダーに必要なファイルをダウンロードするだけで、PC上のソフトウェアとしてインストールされるわけではありません）
npm install
package.jsonで指定されているファイルをインストールするという意味です。
npmコマンドは「Node.js」をインストールと同時に一緒にインストールされています。
このコマンドが認識されなければ、Node.jsのインストール状況を確認してください。
4. プロジェクト名を設定する
gulpfile.jsを開きprojectNameを自分のプロジェクト名に変更します。
// TODO: 自分のプロジェクト名に変更する
const projectName = 'my_project';
この値がアドオンのフォルダー名になります。
4. manifest.jsonを変更する
behavior_pack/manifest.jsonを開いて、自分のプロジェクト用に変更してください。
その際、header.uuidだけは必ず変更してください。
dependenciesの値はスクリプトを動かすためのAPIをMinecraftに読み込む設定です。
削除しないでください。
プロジェクトを開きなおす度に実行すること
コマンドの実行ポリシーを変更する
このコマンド実行ポリシーを変更せずに、後述のgulpコマンドを実行しようとすると、次のような警告文が出て止まります。
gulp : このシステムではスクリプトの実行が無効になっているため...(以下略)
gulpではファイルを操作するので、初期設定ではセキュリティ上の制限がかかっています。
この制限を解除するためには次のコマンドを実行します。
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
コマンドが具体的に何をしているかは、次の記事を参考にしてください。
gulpを使ってデプロイ
デプロイとは「使えるようにする」というような意味です。 上で作成した内容は、そのままでは使えません。 これを使える形にする一連の操作を自動化してあるので、あとはそれを使うコマンドを実行します。
コマンドは次の方法A、方法Bの2通りがあります。
実行したら、Minecraftのワールドにアドオンを適用し、使えるかを確認してください。
A. コマンド実行時にデプロイ
次のコマンドを実行すると、使用した段階の内容がアドオンとして使えるようになります。
gulp
実行後は/AppData/.../com.mojang/development_behavior_packs/[project name]に、使用できる形でファイルがコピーされています。
再びコマンドを入力することで、ファイルを上書きして更新します。
B. ファイル更新毎にデプロイ（推奨）
ファイルを更新する度に、Aと同じ処理を自動で実行します。
gulp watch
ファイルの監視を停止する場合はCtrl + cを押してください。