Skip to content

Commit

Permalink
docs: Make alternate mixin flavors less prominent
Browse files Browse the repository at this point in the history
Since nobody uses them, and they aren't even published on Jitpack (because I don't want to increase build times unnecessarily)
  • Loading branch information
makamys committed Dec 21, 2023
1 parent 1b130b1 commit 0fff377
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions docs/developer-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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.
<details>
<summary>Testing info</summary>

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.
</details>

## Tricks

Expand Down

0 comments on commit 0fff377

Please sign in to comment.