fabric-loom/README.md

# Fabric Loom

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 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](https://fabricmc.net/wiki/tutorial:setup).

## 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](https://github.com/FabricMC/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.
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00			`# Fabric Loom`
recreate repo 2016-08-15 10:22:14 +00:00
Improve debugging repo instructions and fix typos (#323) * Improve debugging repo instructions and fix typos * Fix typo in README 2021-01-03 21:53:39 +00:00			`A [Gradle](https://gradle.org/) plugin to setup a deobfuscated development environment for Minecraft mods. Primarily used in the Fabric toolchain.`
recreate repo 2016-08-15 10:22:14 +00:00
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00			`* 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)`
Improve debugging repo instructions and fix typos (#323) * Improve debugging repo instructions and fix typos * Fix typo in README 2021-01-03 21:53:39 +00:00			`* Built in support for IntelliJ IDEA, Eclipse and Visual Studio Code to generate run configurations for Minecraft.`
General cleanup by making use of java 16 features (#397) * General cleanup by making use of java 16 features * use jackson-databind in place of gson when reading to a record * Fixes * cleanup * dep updates * Replace commons IOUtils usage with native java * Update fernflower 2021-05-13 21:06:34 +00:00			`* Loom targets the latest version of Gradle 7 or newer`
			`* Supports Java 16 upwards`
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00
			`## 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).`

Improve debugging repo instructions and fix typos (#323) * Improve debugging repo instructions and fix typos * Fix typo in README 2021-01-03 21:53:39 +00:00			`## Debugging Loom (Only needed if you want to work on Loom itself)`
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00
			`_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`
Improve debugging repo instructions and fix typos (#323) * Improve debugging repo instructions and fix typos * Fix typo in README 2021-01-03 21:53:39 +00:00			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:`
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00			`* A good starting point is to clone the [fabric-example-mod](https://github.com/FabricMC/fabric-example-mod) into your working directory`
Improve debugging repo instructions and fix typos (#323) * Improve debugging repo instructions and fix typos * Fix typo in README 2021-01-03 21:53:39 +00:00			* 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
Improve the readme a little. Feel free to improve via PRs 2021-01-03 21:39:45 +00:00			* 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.`