MinecraftのMODを開発するのに必要な環境の構築を行います。
このページを見ながら作業を進めることで、MOD開発をすぐ始めることができます。
また、他では紹介されない、導入しておくと便利な『ソースコードのバージョン管理環境』も合わせて構築していきます。
※Windowsをベースに説明しています。Mac、Linuxの方は適宜読み替えて下さい。
※Minecraft Java版を購入し、起動できることを確認している前提で説明しています。
1. JDKとJVMのインストール
インストーラーのダウンロード
JDK (Java Development Kit:Java開発キット)とJVM(Java Virtual Machine:Java仮想環境)が一つになった「Eclipse Temurin」のインストーラーをダウンロードします。
開発するMinecraftのバージョンによって必要なJDKのバージョンが異なります。
以下を参考にバージョンを選択しましょう。
Minecraft | JDK | JVM |
---|---|---|
1.20.5~ | 21 | 64bit |
~1.20.4 | 17 | 64bit |
1.17 | 16 | 32bit |
~1.16 | 8 | 32bit |
インストール
- インストーラーを起動する。
- 使用許諾契約書をよく読み、同意する。
- Installation Scope:
インストールするユーザ範囲を選択する。
・現在のユーザのみ:Install just for you
・すべてのユーザ:Install for all users of this machine - カスタム セットアップ:
「Set JAVA_HOME variable」を選択 - インストールを選択
2. Forge MDK のダウンロード
※次項でインストールするIDE「IntelliJ IDEA」を使用して開発する場合、この手順は不要になりました。「IntelliJ IDEA」でプロジェクトを開始するとき、同時に作成されます。
前提MODはForgeやFabricが有名ですが、今回はForgeで開発をしていくとして、MDK(Mod Development Kit:MOD開発キット)をインストールしましょう。
開発を行うバージョンのものをダウンロードして、開発を行うディレクトリにzipを解凍しましょう。
3. 統合開発環境(IDE)のインストール
統合開発環境(IDE)はいくつかありますが、当サイトでは「IntelliJ IDEA」を使用している前提で説明します。
また、Forgeは「Eclipse」と「IntelliJ IDEA」をサポートしています。
インストーラーのダウンロード
2種類ありますが、無料版のインストーラーをダウンロードして下さい。
・IntelliJ IDEA Ultimate(有料)
・IntelliJ IDEA Community Edition(無料)
インストーラーを起動し、こだわりがなければ変更せずにNextでOK。
4. 動作確認
それでは正しくインストールできているか確認するために、IDEで新規プロジェクトを作成して開発モードでMinecraftを起動してみましょう。
プロジェクトの作成
※手順2でmdkをダウンロードして解凍している場合は、[Open]から解凍したフォルダを選択します。この項の手順は飛ばしてください。
- [New Project]を選択します。
- 左のGenerators から 「Minecraft(Old Wizard)」を選択します。
※現在のバージョン(2024.1.2)で「Minecraft」でプロジェクトを作成すると、必要なファイルが不足しているというエラーが発生します。 - 以下の説明を参考に必要な部分を入力して、「Create」ボタンを押下します。
設定内容の説明と入力例
基本設定
タイトル | 説明 | 備考欄 |
---|---|---|
Name | プロジェクト名 | 使用可能文字:[半角英数字][_(アンダースコア)][-(ハイフン)] |
Location | プロジェクトを保存するディレクトリパス | |
Platform Type | ModかPlugin | |
Platform | 前提MOD | |
Minecraft Version | Minecraftのバージョン | |
Forge Version | Forgeのバージョン | |
Mod Id | MODのID | 使用可能文字:[半角小文字の英数字][_(アンダースコア)]のみ(※[英字]始まり) |
Mod Name | MOD名 | |
Main Class | Mainクラスのパッケージとクラス名 | [Group ID].[Artifact ID].[Mod Name]で構成されるので変更不要 |
Use Mixins | Mixin機能 | バニラのコードを変更または拡張するためのツール |
License | ライセンス |
オプション設定
タイトル | 説明 | 備考欄 |
---|---|---|
Descriptions | MODの説明 | |
Authors | MODの作者名 | |
Website | 作者のWebsite | Twitter(X)など記入しとけばいいんじゃないかな? |
Update URL | 新しいバージョンがある確認するURL | 空欄でOK |
ビルドシステムプロパティ
タイトル | 説明 | 備考欄 |
---|---|---|
Group ID | Main Classを構成する1つ目 | |
Artifact ID | Main Classを構成する2つ目 | |
Version | MODのバージョン | 開発が進むごとにファイルを変更するので、とりあえずでOK |
JDK | Java開発キット | 必要なバージョンが自動で選択される |
ビルド
プロジェクトを作成すると、MODの開発に実行に必要な設定などを行います。
「Background Tasks」というウィンドウが消えるか
「Run」パネルに「BUILD SUCCESSFUL」と表示されるまで待機します。
もし赤い文字でエラーが発生した場合、エラーの内容を確認して必要な対応を行って下さい。
対応後、右にある「象マーク」を選択して表示されるパネル(Gradle)の「Run Configurations」の中の「~ build」をダブルクリックしてビルドを完了させて下さい。※[~]には、前項で指定した[Artifact ID]が設定されます。
自動設定の適用
- 「象マーク」を選択して、「Gradleパネル」を開く。
- 「Tasks」>「forgegradle runs」>「genIntellijRuns」をダブルクリックして実行する。
- 「BUILD SUCCESSFUL」が表示されるまで待機する。
※「genIntellijRuns」を実行すると、デバッグやテストを行うのに必要な設定、ライブラリの依存関係の設定、プロジェクト構成の調整などを自動で行います。
Minecraftをデバッグモードで起動
- 「象マーク」を選択して、「Gradleパネル」を開く。
- 「Tasks」>「forgegradle runs」>「runClient」をダブルクリックする。
- Minecraftが起動します。
確認事項
- Mod一覧(タイトル画面 > Mods)に「自分のMOD名」、選択した「Forgeバージョン」があるか。
プロジェクトで設定した内容が表示されているかと思います。
プロジェクトを作成時に設定した内容と一致する部分がありますね。
- 新規ワールドをクリエイティブモードで作成し、「example_block」を取り出し、配置できるか。
※テクスチャは存在しないため、エラーを示す「黒と紫のチェック柄」で表示されます。
5.IntelliJ IDEAの日本語化
たまにエラーメッセージが文字化けすることがありますが、開発環境を日本語化する方法です。必須ではありませんが、お好みで設定して下さい。
- Settingsウィンドウを開きます。(ショートカットキー:Ctrl + Alt + S)
- Pluginsを選択して、検索欄に「Japanese」と入力する。
- 「Japanese Language Pack / 日本語言語パック」を[Install]する。
- [OK]を選択すると、再起動を促されるので、[Restart]を選択する。
これでIDEが再起動して日本語化されているはずです。
もし日本語化しているのが原因で文字化けしていたりしたら、同じ手順で解除すればOKです。
6.ソースコード管理
ソースコードの管理を適切に行っていると、ソースコード変更によって取り返しのつかないバグ、不具合が発生してしまった場合でも、最悪、正常に動いてたときのソースコードに戻すことができます。
また、保存(専門用語:「コミット」)したときから、どのようなソース変更を行って今のソースコードとなったのか、簡単に違い(専門用語:「差分」や「Diff」)を確認することができます。
※チームで開発を行うときにも使いますが、ここでは解説しません。
Gitのインストール
インストーラーを起動して、セットアップを進めて下さい。
「Next」連打でOKです。
Sourcetree のインストール
Gitを分かりやすいGUIで操作できるソフトです。
Registration
「スキップ」を選択
Tool Install
「Mercurial」のチェックを外す
Preferences
・ユーザ名
・メールアドレス
どこかに登録されるわけではないので、適当でもOK。
ソース管理フォルダの指定
ソース管理するフォルダのことを「リポジトリ」と言います。
- 「Create」を選択
- 「リポジトリ」のパスを設定
- リポジトリの名前を設定
- 「作成」ボタンを押下
「出力先ディレクトリのエラー」が表示された場合は「はい」を選択
これで設定は完了です。
どのように使うかは、実際に手を動かしながらの方がいいので、MOD開発ページで一緒に説明していきます。
現在記事を執筆中です。もうしばらくお待ち下さい。
おまけ:目に優しいダークモード
「メニューバー」>「ツール」>「オプション」>「全般」>「Theme: Dark」