MOD開発環境を作る

Minecraft のMod開発環境を構築する

以下の構築環境は、主に「クライアントユーザ向け」のMOD構築です。

ModLoaderを使用する場合は、

Setup3の minecraft.jar(Modloader導入済)と　minecraft_server.jar(ModLoaderを入れてない状態)の両方を用意して下さい。

※MinecraftForgeを導入する場合はMinecraftForge導入手順（MCP)を参照してください。

前提MODについて

• 1.5.x現在、前提MODはMinecraftForgeが主流になっています。
  昔はModLoaderが主流でしたが、現在ではForgeの方が以下の理由により好まれる傾向にあります。
  • 更新が早い
  • 導入が簡単
  • Moddingしやすい（高度な機能を実現するAPIが豊富）
  • ModLoader用MODも開発できる（ModLoaderと同じ手法でのModdingもできる）
  • チュートリアルが充実している
  • 意図しなくてもシングル／マルチ両対応MODを開発できる
  • Forge対応MODが多い
• 上記の理由により、特にModLoaderにこだわる理由がないのであれば、Forgeを使って開発するようにしましょう。

(Setup.1) JDK(Java SE Development Kit)をダウンロードする

JDK(Java SE Development Kit)をダウンロードするには、
http://www.oracle.com/technetwork/java/javase/downloads/index.html をクリックして下さい。
ダウンロードするバージョンは、JDKの最新版で問題ありません。
（ただし、開発時にはJava7以降の機能は使わないようにしましょう）

JDK DOWNLOADというボタンがあるのでそのリンクを押します。
そして Oracle Binary Code License Agreement for Java SE に同意するために、
Accept License Agreement(訳: ライセンスに同意する)のラジオボタンを選択(クリック)して、
その後、自分のプラットフォームに合わせたJDKのダウンロードリンクをクリックしましょう。

windows x86 = 32bit/windwos x64 = 64bit

JDKのインストール後、環境変数の設定が必要なことがあります(ほぼ必ず)
（Windows7 + Java8u5 現在は環境変数の設定は必要ありません）

(Setup.2) Minecraft Code Pack(MCP) を入手

Download: http://mcp.ocean-labs.de/index.php/MCP_Releases

上記をダウンロード後、mcp(バージョン).zip を解凍して下さい。

解凍後は、適当な場所(例: C:\McRoot\ ) にフォルダを生成し、解凍した中身を移す。

(※フォルダ名は、日本語等のマルチバイトの場合、不具合が起きる可能性があるため、英数をお勧めします)

(Setup.3) Minecraft 関連をダウンロードとコピーペースト

1. Minecraft Server Jar(minecraft_server.jar)をダウンロードする。　(Download: http://www.minecraft.net/download ))

2. minecraft_server.jar をMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

※1.5.x以前のバージョン

3. %appdata%\.minecraft/bin を、フォルダごとMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

4. %appdata%\.minecraft/resource を、フォルダごとMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

※1.6.xのバージョン

3. %appdata%\.minecraft/assets を、フォルダごとMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

4. %appdata%\.minecraft/libraries を、フォルダごとMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

5. %appdata%\.minecraft/versionsフォルダ内に、MOD開発を行いたいバージョン名のフォルダがあるかを確認する(見当たらない場合、minecraftログイン画面の"Edit Profile"から"Use version"でバージョンを選択、"Save Profile"を押した後に起動することで追加される)

6. %appdata%\.minecraft/versions を、フォルダごとMCPを設置した場所の\jars(例: C:\McRoot\jars )にコピーを行う

(Setup.4) デコンパイルを行おう

1. 先程適当な場所(例: C:\McRoot\) に decompile.bat というファイルがあるので、それをダブルクリックする。

2. するとデコンパイルが始まるので、終わるまでお茶でも飲んで待っていよう

3. デコンパイルされたソースは、先程適当な場所(例: C:\McRoot\src ) 内に展開される

　 ├この時点で失敗する場合は、minecraft.jar, minecraft_server.jar, MCP のいずれかのバージョンが合っていない可能性がある。

　 └ macの場合は、ターミナルでMCPROOT/へ移動した後./decompile.shと入力してdecompile.shを実行する。

4. ModLoaderを導入した場合は、MCPROOT/src/minecraft/net/~/srcフォルダ内に

　　BaseMod.java, ModLoader.java も展開される。（ModLoader 導入成功）

　 └MCP 2.X 以前の様に enable_modloader.bat を実行する必要はありません。（実行すると不具合が発生する）

(Option)

5. このままではMLPropが使えないので、ModLoaderの配布ページ　(Download: http://www.minecraftforum.net/topic/75440-v125-risugamis-mods-everything-updated/ ))
からDecompileFixesをダウンロードし

　 解凍したMLProp.javaをMCPROOT/src/minecraft/net/minecraft/src/minecraft/net/minecraft/srcフォルダ内に上書きする。

　 MLProp.javaを開いて1行目のコメントアウトを削除する。

//package net.minecraft.src;　→　package net.minecraft.src;

ソースファイルの作成

既存のクラスを変更する場合は C:\McRoot\src/minecraft/net/minecraft/src/ 内にあるソースコードを変更する。

自作のクラスを追加する場合も、このフォルダに追加する。

最初の内は無理をせず BlockXXX.java や ItemXXX.java などをコピーして練習すると感触をつかみやすい。

欲しい機能がある場合は、その機能を持つソースを覗いてみよう。（爆発を起こしたい→クリーパーのソースを見る…など）

既存のクラスを変更すると、他の MOD と競合することがあるので、レシピの追加などは ModLoader を使ったほうが無難。

ModLoaderを使用する場合は、BaseModを継承したクラスを作成する。

その際クラス名の先頭に"mod_"というプレフィックスをつけること。（つけないと ModLoader から認識されません）

cleanup.bat を実行すると、decompile 時に生成されたフォルダ以下が全て削除されます。

ソースコードは必ずバックアップを取ることを推奨 します。

リソースの作成と配置

自作のテクスチャを使用する場合は、作成して好きな場所に保存しておくこと。

自作のリソースは C:\McRoot\bin\minecraft\ に配置する。

公式のファイルとの区別がつきやすいようなフォルダ名・ファイル名にするのが良い。

(例 : C:\McRoot\bin\minecraft\mod\sample.png など)

cleanup.batを実行すると、decompile時に生成されたフォルダ以下が全て削除されます。

リソースのマスターデータは別のフォルダにバックアップをすることを推奨 します。

Eclipseを使用している場合

minecraft.jarにリソースファイル(主にテクスチャ等の画像)を入れる場合

C:\McRoot\jars\bin\に入ってるminecraft.jarの中に配置する。

.minecraftフォルダの中に入れる場合

C:\Users\(ユーザー名)\AppData\Roaming\.minecraftの中の任意のフォルダに入れる。

設定ファイルは.minecraft\configか.minecraft\modsに入れる。

音声ファイルは.minecraft\resource\modsに入れる。

コンパイル

recompile.batを実行する。

エラーが出た場合は、コマンドプロンプトに詳細が表示されるので原因を取り除く。

コンパイルに失敗した場合、テストプレイを実行できない。

日本語のコメントを記述した場合、コンパイルに失敗するため、/MCPROOT/conf/mcp.cfg内のCmdRecompの末端に "-encoding utf-8" と記述することによりコンパイルすることができるようなる。

動作テスト

startclient.bat を実行すると、変更を加えた状態でテストを行える。

テストプレイ時は C:\McRoot\jars\ が .minecraft\に相当し、セーブファイルは C:\McRoot\jars\saves に作成される。

テストのためのアイテムやブロックがないときは、既存のセーブデータのコピーによって対処するといいだろう。

動作テストで満足できないときは、1に戻ってやり直そう。

配布ファイルの出力

※MCP 3.X で大きく仕様が変更されたので注意。

配布するファイルを出力する場合は C:\McRoot\reobfuscate.bat を実行する。

ファイル作成に成功すると MCPROOT/reobf に配布する class ファイルとリソースデータが出力される。

MCP 2.X 以前の様にファイルを列挙する必要はない。

自作MODを実際に導入して最終テスト

実際に minecraft.jar に導入してテストを行う。

ModLoader を入れた場合、 ModLoader を導入 したあと class ファイルをZIP内に書き込む。

もちろん META-INF は削除すること。

最後に起動テストをして完了。

うまくいったら好きな場所に公開してみよう。

バッチファイル一覧

• decompile

minecraft.jar、minecraft_server.jar をデコンパイルして、ソースファイルを src フォルダに出力する

• recompile

src フォルダにあるソースファイルをコンパイルし、minecraft.jar、minecraft_server.jar を作成する

• startclient

コンパイルされた minecraft.jar を実行し、ゲームを実行する

• startserver

コンパイルされた minecraft_server.jar を実行し、サーバーを立てる

• reobfuscate

実行ファイルから差分ファイルを割り出し、配布用の class ファイルとリソースを出力する

• cleanup

デコンパイルで作成されたフォルダを全て削除する （削除されたファイルは元に戻せないので注意）

動画

Minecraft MODの作り方講座 【下準備編】