Special-purpose fork of https://github.com/FabricMC/fabric-loom
421b41ebc7 | ||
---|---|---|
.github/workflows | ||
bootstrap | ||
gradle/wrapper | ||
src | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
HEADER | ||
LICENSE | ||
README.md | ||
build.gradle | ||
checkstyle.xml | ||
codenarc.groovy | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
settings.gradle |
README.md
Fabric Loom
A Gradle plugin to setup a deobfuscated development environment for Minecraft mods. Primarily used in the Fabric toolchain.
- Has built in support for tiny mappings (Used by Yarn)
- Utilises the Fernflower and CFR decompilers to generate source code with comments.
- Designed to support modern versions of Minecraft (Tested with 1.14.4 and upwards)
- Built in support for IntelliJ IDEA, Eclipse and Visual Studio Code to generate run configurations for Minecraft.
- Loom targets the latest version of Gradle 7 or newer
- Supports Java 16 upwards
Use Loom to develop mods
To get started developing your own mods please follow the guide on Setting up a mod development environment.
Debugging Loom (Only needed if you want to work on Loom itself)
This guide assumes you are using IntelliJ IDEA, other IDE's have not been tested; your experience may vary.
- Import as a Gradle project by opening the build.gradle
- Create a Gradle run configuration to run the following tasks
build publishToMavenLocal -x test
. This will build Loom and publish to a local maven repo without running the test suite. You can run it now. - Prepare a project for using the local version of Loom:
- A good starting point is to clone the fabric-example-mod into your working directory
- Add
mavenLocal()
to the repositories:- If you're using
id 'fabric-loom'
insideplugins
, the correctrepositories
block is insidepluginManagement
in settings.gradle - If you're using
apply plugin:
for Loom, the correctrepositories
block is insidebuildscript
in build.gradle
- If you're using
- Change the loom version to
0.6.local
. For exampleid 'fabric-loom' version '0.6.local'
- Create a Gradle run configuration:
- Set the Gradle project path to the project you have just configured above
- Set some tasks to run, such as
clean build
you can change these to suit your needs. - Add the run configuration you created earlier to the "Before Launch" section to rebuild loom each time you debug
- You should now be able to run the configuration in debug mode, with working breakpoints.