Table of Contents
Mod 開発環境のセットアップ
前提条件
- Java 21 以降(Java 21 が推奨)の Java Development Kit (JDK)。インストーラーについては、 https://adoptium.net/releases.html にアクセスしてください。
- 専門家の場合は、 http://jdk.java.net/ からJDKを入手できます。これを抽出し、システム変数を手動で設定する必要があります。
-
- これらのいずれにも精通していない場合は、ほとんどの人が Mod 製作に選択する Intellij IDEA を使用することをお勧めします。
Mod のセットアップ
手順
- fabric-example-mod(Kotlin等を使用する場合は、template mod generator を使用してください。)をコピーし、
LICENSE
〔ライセンス〕ファイルとREADME.md
〔最初にお読みください.md〕ファイルを除外します。これらはテンプレート自体に適用され、Mod には必要ではありません。 gradle.properties
を編集します:- 必ず
archives_base_name
とmaven_group
を希望の値に設定してください。 - Minecraft、マッピング、ローダー、および Loom のバージョンを必ず更新してください。これらはすべて https://fabricmc.net/develop/ から照会でき、あなたが希望するバージョンに合うようにしてください。
build.gradle
で使用する予定の他の依存関係を追加します。
- build.gradle ファイルを IDE にインポートします。特定の IDE については、次のセクションを参照してください。
- 幸せな Mod 製作を!
Fabric の Mod ID の変更
Minecraft 1.19.2 から、Fabric APIの Mod ID は fabic
から fabric-api
に変更されました。Mod を 1.19.2 より前のバージョンに戻す場合は、fabric.mod.json
の depends
を fabric
に変更する必要があります。
IntelliJ IDEA
JetBrains の IntelliJ IDEA を使用している場合は、次の手順に従ってください:
- IDEAのメインメニューで、 'Import Project' 〔プロジェクトのインポート〕を選択します(または、プロジェクトを既に開いている場合は、 File 〔ファイル〕→ Open… 〔開く…〕を選択します)。
- プロジェクトの build.gradle ファイルを選択して、プロジェクトをインポートします。
- Gradle のセットアップが完了したら、プロジェクトを閉じて(File 〔ファイル〕→ Close Project 〔プロジェクトを閉じる〕)、プロジェクトを再度開いて、実行構成が正しく表示されない問題を修正します。
- (それでも実行構成が表示されない場合は、 IDEA の Gradle タブから Gradle プロジェクトを再インポートしてみてください。)
オプションですが、お勧めします: デフォルトでは、 IntelliJ はプロジェクトをビルドするために Gradle に委任します。これは Fabric には不要であり、ビルド時間が長くなり、ホットスワップに関連する奇妙な問題が発生します。組み込みコンパイラを使用するには、次のようにします:
- Gradle タブから 'Gradle Settings' 〔Gradle 設定〕ダイアログを開きます。
- 'Build and run using' 〔ビルド及び実行に使用〕および 'Run tests using' 〔テストの実行に使用〕フィールドを 'IntelliJ IDEA' に変更します。
残念ながら、現在、 'Build and run using' 〔ビルド及び実行に使用〕および 'Run tests using' 〔テストの実行に使用〕オプションに IDE 全体のデフォルトを設定することは不可能であるため、新しいプロジェクトごとにこれらの手順を繰り返す必要があります。
注: idea
gradle タスクを実行しないでください。開発環境を壊すことが知られています。
IntelliJ IDEA を使用している場合は、 MinecraftDev プラグイン を使用できます。 このプラグインは、 Fabric プロジェクトの自動生成のサポートに加えて、 検査、アクセサー/シャドウフィールドの生成、ミックスインターゲット参照(JVM記述子)のコピーなどのミックスイン関連機能のサポートを追加します。 IntelliJ の内部プラグインブラウザを使用して、 File 〔ファイル〕 → Settings 〔設定〕 → Plugins 〔プラグイン〕に移動し、 Marketplace 〔マーケットプレイス〕 タブをクリックして、 Minecraft を検索することでインストールできます。
注: mcdev プラグインのデフォルトのテンプレートは、最新の不安定なバージョンの loom を盲目的に使用します。注意して使用してください。
Eclipse
Eclipse を使用していて、 IDE に構成を実行させたい場合は、 gradlew eclipse
を実行できます。 次に、 'File' 〔ファイル〕- 'Import…' 〔インポート…〕メニュー、 'General' 〔一般〕→ 'Existing Projects into Workspace' 〔既存のプロジェクトをワークスペースに〕を使用して、プロジェクトを通常の(非 gradle) Eclipse プロジェクトとしてワークスペースにインポートできます。
Visual Studio Code
VSCode を使用している場合は、 これらの手順 に従ってください。
Minecraft のソースコードの生成
Minecraft のソースコードを読むことは、Mod 製作の重要な部分です。 残念ながら、 Minecraft EULA に違反しているため、 Minecraft のソースコードを公開できません。 Minecraft のソースコードを自分で生成する必要があります。
Minecraft ソースコードを生成します。 genSources
gradle タスクを実行します。
IDE に gradle 統合がない場合は、ターミナルで次のコマンドを実行します: gradlew genSources
(または Linux/MacOS では ./gradlewgenSources
)。
コンピュータの電源によっては、時間がかかる場合があります。
タスクの実行後に gradle を更新する必要がある場合があります。
ソースの読み取り方法については、 Minecraft のソースコードの読み方 を参照してください。
はじめよう
アイテムの追加 または ブロック を試してください。 Minecraft を再起動せずに変更を適用する にアクセスすることもおすすめします。
アドバイス
- Fabric API は、 Mod の開発に厳密に必要なわけではありませんが、その主な目標は、ゲームエンジンが提供しない相互互換性とフックを提供することであるため、強くお勧めします。ウィキのチュートリアルのいくつかでさえ、暗黙的に Fabric API を必要とします。
- 時折、 fabric-loom (私たちの開発した Gradle ビルドプラグイン)の開発に伴い、キャッシュファイルのリセットを必要とする問題が発生する場合があります。これは、
gradlew cleanloom
を実行することで実行できます。gradlew --stop
を実行すると、いくつかのまれな問題にも役立ちます。 - 最新の Loom バージョン(
build.gradle
で定義されている)と、 Mod の Fabric ローダーおよび Fabric API バージョン(build.gradle
またはgradle.properties
で定義されている)についていきます。最新バージョンは https://fabricmc.net/develop/ にあります。古いバージョンの Minecraft でさえ、最新の Loom と最新の Fabric ローダーでサポートされています。 gradle /wrapper/gradle-wrapper.properties
で定義できる最新の Gradle バージョンについていく。古いバージョンの Minecraft は、最新の Gradle でサポートされています。- Gradle のバージョンが異なれば、 Java のバージョンも異なります。 通常、最新の Gradle は推奨される Java バージョン 17 をサポートします。
- 古いバージョンの Minecraft 用の Mod を開発している場合は、
gradle.properties
を変更するだけでなく、build.gradle
とミックスイン構成で Java 互換バージョンを変更する必要がある場合もあります。 - 遠慮なく質問してください!私たちはあなたを助け、あなたと協力してあなたの夢の Mod を実現するためにここにいます。
トラブルシューティング
Missing sounds
Gradle プロジェクトを IDE にインポートするときに、アセットが正しくダウンロードされない場合があります。この場合、 IDE の組み込みメニューを使用するか、単に gradlew downloadAssets
を実行することにより、 downloadAssets
タスクを手動で実行します。
次は何ですか?
最初の アイテム を作成します。