Build files:
| File | Description |
|---|---|
build.gradle |
Configures the compilation process. |
gradle.properties |
Contains properties for Minecraft, fabric, and your mod. |
settings.gradle |
Configures the plugin repositories. |
Fabric files:
These files are located at src/main/resources.
| File | Description | Additional information |
|---|---|---|
fabric.mod.json |
Contains metadata about your mod. | wiki:fabric_mod_json_spec |
modid.mixins.json |
Contains a list of all your mixin files. | wiki:mixin_registration |
assets/modid/icon.png |
The icon of your mod. | wiki:fabric_mod_json_spec#icon |
First of you must replace all occurrences of modid with the id of your mod.
If your mod doesn't use mixins you can safely remove the mixin entry in your fabric.mod.json as well as delete any *.mixin.json files.
This template has the legacy fabric api included in it's build script, more info about the api can be found at it's github repo. If you know what you are doing you can also safely remove the api from the build script as it isn't required.
# Compile your mod
./gradlew build
# Remove old build files
./gradlew clean
# Generate Minecraft sources
./gradlew genSources
# Launch a modded Minecraft client
./gradlew runClient
# Kill gradle if it's doing stupid things
./gradlew --stopAdditional tutorials and tips can be found in the wiki.
For more detailed setup instructions please see the fabric wiki.
If you are new to fabric or Minecraft modding in general then this wiki page may help you.
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.