diff --git a/README.md b/README.md index 968e67f..f2c5d76 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ -# fabric-loom -Gradle plugin for Fabric +# Fabric Loom -Usage: `gradlew setup idea` -(Use `./gradle` on macOS and Linux) +A [Gradle](https://gradle.org/) 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](https://github.com/FabricMC/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 target 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](https://fabricmc.net/wiki/tutorial:setup). + +## Debugging loom (Only needed if you want to work on loom its self) + +_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](https://github.com/FabricMC/fabric-example-mod) into your working directory + * Add `mavenLocal()` to the buildscript repositories, usually found in `settings.gradle` or at the top of the `build.gradle` file + * 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.