From 0fff377da8943d0d95e3982ef29a8d24d61085da Mon Sep 17 00:00:00 2001 From: makamys Date: Thu, 21 Dec 2023 21:19:27 +0100 Subject: [PATCH] docs: Make alternate mixin flavors less prominent Since nobody uses them, and they aren't even published on Jitpack (because I don't want to increase build times unnecessarily) --- docs/developer-usage.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/developer-usage.md b/docs/developer-usage.md index e92cf40..26e7a79 100644 --- a/docs/developer-usage.md +++ b/docs/developer-usage.md @@ -18,12 +18,7 @@ You can also depend on modules individually: ```gradle dependencies { - // One of these (note: this module doesn't have dev jars) implementation("com.github.LegacyModdingMC.UniMixins:unimixins-mixin-1.7.10:$unimixinsVersion") - //implementation("com.github.LegacyModdingMC.UniMixins:unimixins-mixin-1.7.10-spongepowered:$unimixinsVersion") - //implementation("com.github.LegacyModdingMC.UniMixins:unimixins-mixin-1.7.10-fabric:$unimixinsVersion") - //implementation("com.github.LegacyModdingMC.UniMixins:unimixins-mixin-1.7.10-gasmix:$unimixinsVersion") - //implementation("com.github.LegacyModdingMC.UniMixins:unimixins-mixin-1.7.10-gtnh:$unimixinsVersion") // You don't need all the modules, only the ones your mod requires. implementation("com.github.LegacyModdingMC.UniMixins:unimixins-compat-1.7.10:$unimixinsVersion:dev") @@ -36,7 +31,21 @@ dependencies { } ``` -> If you are *not* using UniMix or GTNH's Mixin fork, you will need to add the compat module and set the `-Dunimixins.compat.hackClasspathModDiscovery=true` JVM flag, or Forge may fail to discover your mod or its dependencies. +
+Testing info + +If you want to depend on a local build, you need to use `io.github.legacymoddingmc.unimixins` instead of `com.github.LegacyModdingMC.UniMixins`. + +And here's how you depend on the Very Optional modules (not published on Jitpack). +```gradle + //implementation("io.github.legacymoddingmc.unimixins:unimixins-mixin-1.7.10-spongepowered:$unimixinsVersion") + //implementation("io.github.legacymoddingmc.unimixins:unimixins-mixin-1.7.10-fabric:$unimixinsVersion") + //implementation("io.github.legacymoddingmc.unimixins:unimixins-mixin-1.7.10-gasmix:$unimixinsVersion") + //implementation("io.github.legacymoddingmc.unimixins:unimixins-mixin-1.7.10-gtnh:$unimixinsVersion") +``` + +Note: If you are *not* using UniMix or GTNH's Mixin fork, you will need to add the compat module and set the `-Dunimixins.compat.hackClasspathModDiscovery=true` JVM flag, or Forge may fail to discover your mod or its dependencies. +
## Tricks