Conditional Proxy Mod Initializers

Quick rating

Conditional Proxy Mod Initializers

No reviews yet

A simple library for running a proxy Fabric initializer if a required mod exists

API/Library
Mod Loaders
Fabric
Minecraft
1.21

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Dev Environment
Client Required
Server Required

About

Project Details

Type
Mod
License
GNU General Public License v3.0 only
Latest Version
1.0
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

Modrinth ID

Resources

External Links

Source Issues Wiki Discord

About

Description

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 running new ConditionalModInitializer.Builder())
    • mods() -> List<String> : Returns the list of any mod that is required for this initializer
    • required_mods() -> List<String> : Returns list of all required mods for this initializer
    • can_run -> Boolean : Whether or not the initializer has ran yet
    • environment() -> ExtendedEnvType : Returns the environment (initializer type) for this initializer
      • ExtendedEnvType.CLIENT : ClientModInitializer
      • ExtendedEnvType.SERVER : ModInitializer
      • ExtendedEnvType.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

Screenshots

Gallery

  • the sin I needed to commit in order to make this mod work
    the sin I needed to commit in order to make this mod work Never let me cook

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

<1,000
Downloads
Last Updated
CurseForge
Created
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works