aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorshedaniel <daniel@shedaniel.me>2021-02-03 11:51:52 +0800
committershedaniel <daniel@shedaniel.me>2021-02-03 11:51:52 +0800
commit9c6c6164fbdeef7e2b3951222bb361ea8d322bd7 (patch)
tree056a26901dcb1fe1876b2e55ec877327d573ee18
parent20b016d6529110892401df686409ef929fccffcb (diff)
downloadarchitectury-loom-9c6c6164fbdeef7e2b3951222bb361ea8d322bd7.tar.gz
architectury-loom-9c6c6164fbdeef7e2b3951222bb361ea8d322bd7.tar.bz2
architectury-loom-9c6c6164fbdeef7e2b3951222bb361ea8d322bd7.zip
Update README.md
-rw-r--r--README.md43
1 files changed, 4 insertions, 39 deletions
diff --git a/README.md b/README.md
index 42b40d85..7d974c15 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
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.
@@ -10,47 +12,10 @@ A [Gradle](https://gradle.org/) plugin to setup a deobfuscated development envir
* 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.~~
- - Currently, only IntelliJ IDEA and Visual Studio Code works with Forge Loom.
+ - Currently, only IntelliJ IDEA and Visual Studio Code work with Forge Loom.
* 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
## Usage
-Starting with a Fabric project similar to the example mod,
-
-## 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._
-
-Then you need to set `loom.forge = true` in your `gradle.properties`,
-and add the Forge dependency:
-
-```groovy
-forge "net.minecraftforge:forge:1.16.4-35.1.7"
-```
-
-You also need to remove the Fabric Loader and Fabric API dependencies.
-You should also remove any access wideners and replace them with a Forge AT.
-
-### Mixins
-
-Mixins are used with a property in the `loom` block in build.gradle:
-
-```groovy
-loom {
- mixinConfig = "mymod.mixins.json"
-}
-```
-
-## Limitations
-
-- Launching via IDE run configs doesn't work on Eclipse or VSCode.
-- The srg -> yarn remapper used for coremod class names is *really* simple,
- and might break with coremods that have multiple class names per line.
-
-## Known Issues
-- https://github.com/architectury/forgified-fabric-loom/issues \ No newline at end of file
+View the [documentation](https://architectury.github.io/architectury-documentations/docs/forge_loom/) for usages. \ No newline at end of file