Special-purpose fork of https://github.com/FabricMC/fabric-loom
 
 
 
Go to file
Jason 671328795e
Generate fabric.mod.json for included submodule jars (#343)
* Generate fabric.mod.json for included submodule jars

* Appease checkstyle
2021-02-02 23:03:57 +00:00
.github/workflows Fix build. 2021-01-16 13:52:25 +00:00
gradle/wrapper downgrade to gradle 4.9, fix tiny-remapper deprecations, restore old dev/noclassifier behaviour for default RemapJarTask settings 2019-07-24 22:34:27 +02:00
src Generate fabric.mod.json for included submodule jars (#343) 2021-02-02 23:03:57 +00:00
.editorconfig General code cleanup (#313) 2020-12-24 20:58:30 +00:00
.gitattributes Update Gradle wrapper to 3.0 (#2) 2016-08-16 23:29:10 +01:00
.gitignore Test across java and gradle versions with github actions. (#218) 2020-06-08 15:19:11 +01:00
HEADER add license header 2018-10-27 16:14:05 +02:00
LICENSE Update Gradle wrapper to 3.0 (#2) 2016-08-16 23:29:10 +01:00
README.md Improve debugging repo instructions and fix typos (#323) 2021-01-03 21:53:39 +00:00
build.gradle Improve run configs (#318) (#338) 2021-01-29 18:04:39 +00:00
checkstyle.xml Fix checkstyle config not supporting windows line endings 2019-11-13 18:00:07 +00:00
gradle.properties Revert to old name 2018-10-22 19:25:18 +01:00
gradlew Update Gradle to 5.1.1 for Lazy Configuration support 2019-06-12 17:13:25 -05:00
gradlew.bat Update Gradle to 5.1.1 for Lazy Configuration support 2019-06-12 17:13:25 -05:00
settings.gradle Update Gradle wrapper to 3.0 (#2) 2016-08-16 23:29:10 +01:00

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 a wide range of Gradle versions. Tested with 4.9 up to 6.7
  • Supports the latest version of Java all the way down to Java 8

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.

  1. Import as a Gradle project by opening the build.gradle
  2. 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.
  3. 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' inside plugins, the correct repositories block is inside pluginManagement in settings.gradle
      • If you're using apply plugin: for Loom, the correct repositories block is inside buildscript in build.gradle
    • Change the loom version to 0.6.local. For example id 'fabric-loom' version '0.6.local'
  4. 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
  5. You should now be able to run the configuration in debug mode, with working breakpoints.