Fabric は、Mod プロジェクトを簡単に作成することを可能にする Fabric Template Mod Generator を提供しています。手動でプロジェクトを作成したい場合は、サンプルの Mod リポジトリを使用することができます。手動で作成する セクションを参照してください。

プロジェクトの生成

Fabric Template Mod Generator を使用すると新しいプロジェクトを生成することができます。パッケージ名、Mod 名、Mod が対応する Minecraft バージョンの入力が必要です。

パッケージ名は小文字で、ドットで区切り、一意であることが求められます。他のプログラマーのパッケージと競合しないようにしてください。 通常、com.example.mod-id のように、インターネットドメインを逆順にした形式で記述されます。

Kotlin を使用したい場合や、データ生成を行いたい場合は、Advanced Options セクションで適切なオプションを選択してください。

必要な項目の入力が完了したら、Generate ボタンを押してください。ジェネレータが新しいプロジェクトを zip ファイル形式で生成します。

zip ファイルを任意の場所で解凍して、解凍されたフォルダを IntelliJ IDEA で開いてください。

プロジェクトのインポート

プロジェクトを IntelliJ IDEA で開くと、IDE は自動で Gradle 設定を読み込み、セットアップに必要なタスクを行います。

Gradle ビルドスクリプトに関する通知が表示された場合は、Gradle プロジェクトのインポート ボタンを押してください:

プロジェクトのインポートが完了すると、プロジェクトツールウィンドウにファイルが表示され、Mod の開発を始めることができるようになります。

手動によるプロジェクトの作成

WARNING

サンプルの Mod リポジトリをクローンするためには、Git のインストールが必要になります。

Fabric テンプレート Mod ジェネレータを使用できない場合は、次のステップを踏むことで手動で新しいプロジェクトを作成できます。

まず、Git を使用してサンプル Mod リポジトリをクローンします:

git clone https://github.com/FabricMC/fabric-example-mod/ my-mod-project

このコマンドは、リポジトリを my-mod-project という名前のフォルダにクローンします。

続いて、フォルダ内の .git フォルダを削除し、IntelliJ IDEA でプロジェクトを開いてください。 .git フォルダが表示されない場合は、ファイルマネージャで隠しファイルの表示を有効にする必要があります。 .git フォルダが表示されない場合は、ファイルマネージャで隠しファイルの表示を有効にする必要があります。

プロジェクトを IntelliJ IDEA で開くと、IDE は自動で Gradle 設定を読み込み、セットアップに必要なタスクを行います。

前述の通り、Gradle ビルドスクリプトに関する通知が表示された場合は、Gradle プロジェクトのインポート ボタンを押してください。

テンプレートの編集

プロジェクトがインポートされたら、プロジェクトの詳細をあなたの Mod の詳細に合わせて編集してください:

• gradle.properties ファイル内の maven_group と archive_base_name を編集します。
• fabric.mod.json ファイル内の id、name、description プロパティを編集します。
• Minecraft、マッピング、Fabric Loader、Loom のバージョンを、対応させたい値に編集します。これらは https://fabricmc.net/develop/ で照会できます。

言うまでもないですが、パッケージ名と Mod のメインクラスも適宜編集してください。