diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 11 insertions, 22 deletions
@@ -1,32 +1,21 @@ -# Fabric Loom +# Forgified Loom + +Talk to us on [Discord](https://discord.gg/C2RdJDpRBP)! + +--- + +A fork of [Juuxel's Loom fork]("https://github.com/Juuxel/fabric-loom") that is a fork of [Fabric Loom](https://github.com/FabricMC/fabric-loom) that supports the Forge modding 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. +* ~~Built in support for IntelliJ IDEA, Eclipse and Visual Studio Code to generate run configurations for Minecraft.~~ + - Currently, only IntelliJ IDEA and Visual Studio Code work with Forge Loom. * 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._ +## Usage -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. +View the [documentation](https://architectury.github.io/architectury-documentations/docs/forge_loom/) for usages.
\ No newline at end of file |