https://github.com/cleanroommc/mixinbooter
Allows any mixins that work on mods to work effortlessly. With a single class and an annotation. On 1.12.2.
https://github.com/cleanroommc/mixinbooter
api hook library minecraft mixin
Last synced: 3 months ago
JSON representation
Allows any mixins that work on mods to work effortlessly. With a single class and an annotation. On 1.12.2.
- Host: GitHub
- URL: https://github.com/cleanroommc/mixinbooter
- Owner: CleanroomMC
- License: lgpl-2.1
- Created: 2020-11-02T13:43:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T14:20:35.000Z (4 months ago)
- Last Synced: 2025-03-31T13:18:40.293Z (4 months ago)
- Topics: api, hook, library, minecraft, mixin
- Language: Java
- Size: 380 KB
- Stars: 61
- Watchers: 2
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MixinBooter
### Allows any mixins that work on mods to work effortlessly on 1.8 - 1.12.2
- Current Mixin Version: [UniMix 0.15.3 forked by CleanroomMC, derived from 0.8.7 branch by LegacyModdingMC](https://github.com/CleanroomMC/UniMix)
- Current MixinExtra Version: [0.5.0-rc.1](https://github.com/LlamaLad7/MixinExtras)
### Pseudo-Changelog:
- As of 4.2, MixinBooter's API has changed and ***all mods*** that uses mixins are encouraged to depend on MixinBooter, even those that mixin into vanilla/forge/library classes. To avoid mixin version mismatches with mods crashing trying to implement modded mixins (looking at you VanillaFix). Thanks to [@embeddedt](https://github.com/embeddedt) recommending and helping me introduce this change!
- As of 5.0, [MixinExtras by @LlamaLad7](https://github.com/LlamaLad7/MixinExtras) is shaded. Available for developers to use.
- As of 8.0, MixinBooter will now work from 1.8 - 1.12.2. One single build works with all these versions! (TODO: LiteLoader support?)
- As of 8.4, MixinBooter actively attempts to be compatible with [SpongeForge](https://github.com/SpongePowered/SpongeForge)
- As of 9.2, MixinBooter reinstates the older MixinLoader annotation for 1.8.x usages.
- As of 10.0, MixinBooter follows Mixin 0.8.7
### For Developers ~ Getting Started:
1. Add CleanroomMC's repository and depend on MixinBooter's maven entry:
```groovy
repositories {
maven {
url 'https://maven.cleanroommc.com'
}
}
dependencies {
// Common:
annotationProcessor 'org.ow2.asm:asm-debug-all:5.2'
annotationProcessor 'com.google.guava:guava:32.1.2-jre'
annotationProcessor 'com.google.code.gson:gson:2.8.9'
// ForgeGradle:
implementation ('zone.rong:mixinbooter:10.6') {
transitive = false
}
annotationProcessor ('zone.rong:mixinbooter:10.6') {
transitive = false
}
// RetroFuturaGradle:
String mixinBooter = modUtils.enableMixins('zone.rong:mixinbooter:10.6')
// modUtils.enableMixins('zone.rong:mixinbooter:10.6', 'mod_id.mixins.refmap.json') << add refmap name as 2nd arg (optional)
api (mixinBooter) {
transitive = false
}
annotationProcessor (mixinBooter) {
transitive = false
}
}
```
2. Pick your path:
- Mixin into minecraft, forge or coremods? Make a *coremod* with `IFMLLoadingPlugin` and implement the class with `IEarlyMixinLoader`
- Mixin into normal mods? Make a normal class anywhere in your mod file, implement the class with `ILateMixinLoader`
3. Register your mixin configs
- In either your `IEarlyMixinLoader` or `ILateMixinLoader` you have to return a list of mixin config names via the `getMixinConfigs` method
- This is the path (relative to your `resources` root) to your mixin config.