hibiscus-client/fabric-loom
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improve debugging repo instructions and fix typos (#323)

Browse source 
* Improve debugging repo instructions and fix typos

* Fix typo in README
This commit is contained in:
Juuxel 2021-01-03 23:53:39 +02:00 committed by GitHub
parent 1007c55ad6
commit e61f3fb362
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,27 +1,29 @@
# Fabric Loom
A [Gradle](https://gradle.org/) plugin to setup a deobfuscated development environment for minecraft mods. Primarily used in the Fabric toolchain.
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
* 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](https://fabricmc.net/wiki/tutorial:setup).
## Debugging loom (Only needed if you want to work on loom its self)
## 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:
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
* 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