Compatibility
Minecraft: Java Edition
Platforms
Supported environments
90% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
A simple 5-class mod which adds support for initializing code depending on if a specific mod exists.
This mod will always load last, so there is no need to worry about race conditions due to mod load order.
Code and variables must be available before or during any mod initialization stages (ie cannot be done on datapack reload for example)
Usage:
// Inside main ModInitializer, ClientModInitializer, or any class that gets called at some point during Fabric init
// For running an instance of a ModInitializer:
ConditionalModInitializer myConditionalModInitializer = new ConditionalModInitializer.Builder().mods("some-mod").initializer(SomeOtherInitializer.class).build();
// For running any unspecified code:
ConditionalModInitializer myConditionalRunner = new ConditionalModInitializer.Builder().mods("some-other-mod").found(() -> {
// Code goes here
}).build();
public void onInitialize() {
ConditionalModInitializer.create().mods("some_mod").required_mods("some_other_dependency_mod").initializer(AnotherInitializer.class).build();
}
- NOTE: new ConditionalModInitializer.Builder() MUST be assigned to a variable, or be called inside a function to work! Static declaration (
static{}
will NOT work!)
Docs:
-
ConditionalModInitializer
create()
-> Returns a new Builder() instance. (Same as runningnew ConditionalModInitializer.Builder()
)mods()
-> List<String> : Returns the list of any mod that is required for this initializerrequired_mods()
-> List<String> : Returns list of all required mods for this initializercan_run
-> Boolean : Whether or not the initializer has ran yetenvironment()
-> ExtendedEnvType : Returns the environment (initializer type) for this initializerExtendedEnvType.CLIENT
: ClientModInitializerExtendedEnvType.SERVER
: ModInitializerExtendedEnvType.DEDICATED_SERVER
: DedicatedServerModInitializer
on_found()
-> Runnable : Returns the function to call when a required mod is found
-
ConditionalModInitializer.Builder
-
mods(String...)
: Appends to the list of mods that will allow this initializer to run -
required_mods(String...)
: Appends to the list of required mods for this initializer -
environment(ExtendedEnvType)
: Sets the environment of the initializer (Default:ExtendedEnvType.SERVER
: ModInitializer) -
found(Runnable)
: Code to execute if the mod is found -
initializer(Class<ModInitializer>)
: Initializer to run if the mod is found -
mainInitializer(Class<ModInitializer>)
: Initializer to run if the mod is found -
clientInitializer(Class<ClientModInitializer>)
: Initializer to run if the mod is found -
serverInitializer(Class<DedicatedServerModInitializer>)
: Initializer to run if the mod is found -
build()
: Returns the finalized ConditionalModInitializer
-