FermiumBooter is a mixin mod utility to allow developers to load mixins both early and late, allowing for modifying classes that normally could not be modified otherwise.
Current features include;
-
Enqueue mixins to be applied both early and late, to allow for for modifying Vanilla/Forge classes, as well as mod classes
-
@MixinConfig annotation system to expand on the Forge @Config system, to allow for automatic mixin enqueue based on config toggles
-
Optional compatibility handling through the config annotation system to allow developers to define required/incompatible mods for specific mixins
-
Logged warnings when a mixin using the config annotation system fails compatibility checks
-
Optional forced mixin disabling when a mixin using the config annotation system fails compatibility checks
-
Ingame (disable-able) warning rendering when mixins using the config annotation system fail compatibility checks
-
Enable/disable enqueued mixins prior to application through the use of a Supplier, to allow developer control over optional mixins
-
Utility method to check if a ModID is present similar to Loader.isModLoaded() however usable during mixin enqueue/early mixin application unlike Loader.isModLoaded()
-
Disallow other FermiumBooter enqueued mixins from applying, for testing or tweaking purposes
-
Shadows Mixin 0.8.7 and MixinExtras 0.4.1
For developer usage:
In your IFMLLoadingPlugin init, instead of "Mixins.addConfiguration("mixinConfigName")", use "FermiumRegistryAPI.enqueueMixin("mixinConfigName").
If you are registering it as a late-loaded mixin use "FermiumRegistryAPI.enqueueMixin(true, "mixinConfigName")".
That is all that is required, and FermiumBooter takes care of the rest.
For additional utilities as described previously, all are documented in code with explanations of usage and purpose.
If you have any issues/suggestions/requests, please post them to the Github issue tracker linked above.
Need to get in contact with me, or want to support me? Click the badges below:
Need a server? Click the banner below and use code "fonny" for 25% off your first month with Bisect Hosting:
All Versions
+ Add Version- Fix #9, loading Forge Version classes too early
- Add FermiumTransformerAPI, utility for blocking/partially blocking external IClassTransformers
Hotfix for serverside startup crashes due to logger
- Append general mixin errors to crash reports for easier diagnosing
- Add a custom separate logging file for MixinConfig warnings and general mixin errors
- Allow clicking the ingame MixinConfig warning render to directly open the custom log
- Set the ingame MixinConfig warning render to only display on the main menu
- Add warnIngame MixinConfig option thanks to PR by Nischhelm
- Swap to shadow modified Mixin 0.8.7 (https://github.com/fonnymunkey/SpongeMixin)
- Remove forced mixin config additions as it is no longer needed with above
- Update MixinExtras to 0.5.0 Release (https://github.com/LlamaLad7/MixinExtras/releases/tag/0.5.0)
- Shadow MixinSquared 0.3.3 Release (https://github.com/Bawnorton/MixinSquared/releases/tag/0.3.3)
- Add config-based handling for forcing mixin configs to be added/removed, for simple compat handling for older mods that crash on modern mixin such as Locks and ParticleCulling
- Fix disabling warning render while in-game not updating
- Fix icon texture size
- Update to new logo created by Star_Artsy
- Breaking Change: Rewrite @MixinConfig annotation system to optimize and prevent possible classloading issues.
Some mods such as SRPMixins that use @MixinConfig will need to be updated first before updating FermiumBooter.
Do not report crashes caused by using non-updated versions.
- Add utility method for checking for present ModID's as Loader.isModLoaded() does not work during mixin enqueue/early mixin application
- Add MixinConfig annotation system for expanding on the Forge Config annotation system to automatically enqueue mixins based on config toggles, including ModID compatibility options
- Add compatibility warning logging and render from mixins using the MixinConfig annotation system
- Re-license to LGPLv3
As there are multiple new features/changes remember to please report any issues to the Github issue tracker
Fix compatibility with Cleanroom Loader 0.2.3
Update Mixin to 0.8.7
Update MixinExtras to 0.4.1
Note: Currently Non-Cleanroom MixinBooter loads MixinExtras 0.3.6 first, so newer 0.3.6+ features should not be depended on until MixinBooter updates if full compatibility with all mods is desired
Shadow Mixin 0.8.5
Shadow MixinExtras 0.3.5
Rename file for CleanroomLoader compatibility
Note: While MixinBootstrap/MixinCompat is no longer required, it is still highly recommended you use MixinCompat in a modpack environment regardless
Added handling for when a single configuration is registered with multiple suppliers, evaluated as short-circuit OR, in cases such as a common Accessor mixin
