34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Features
|
|
|
|
## Platform detection
|
|
|
|
Automatic detection of the current modloader (between Fabric, Forge, Neoforge or Other)
|
|
and of the current execution side (client or server) using the mixin engine.
|
|
|
|
Access these via the `PlatformService` class.
|
|
|
|
## Modding compat
|
|
|
|
A mod compatibility mixin plugin is made available at
|
|
`com.nerjal.moddingutils.compat.CompatMixinPLugin` and will use the `Compat` annotation
|
|
to allow you to make mixins only be applied with their respective dependencies are
|
|
loaded.
|
|
|
|
Dependencies need a mod ID at least, but can also include filtering base on authors names
|
|
as well as version ranges.
|
|
|
|
# Usage
|
|
|
|
Add the `https://maven.nerjal.com/releases/` maven repository to your project,
|
|
and import the `com.nerjal:ModdingUtils:<VERSION>` artifact in your project.
|
|
|
|
You are free to bundle this project into yours.
|
|
|
|
Don't hesitate to add a dependency to "the same main version as yours" in your project
|
|
manifest (e.g. `"moddingutils": "~${moddingutils_version}"`) to avoid trying to load
|
|
with breaking changes brought by some other project including a more recent version of
|
|
ModdingUtils.
|
|
|
|
## Latest version
|
|
|
|
[1.1](https://maven.nerjal.com/#/releases/com/nerjal/ModdingUtils/1.1) |