Mod Loading Screen

An innovative loading screen that displays mod installation progress in real time. This universal solution works on all Minecraft versions since it doesn't require the game itself to run. The only requirement is Fabric Loader version 0.12.0 or newer, or Quilt Loader (specific Quilt versions are not specified). Important note: when running on games other than Minecraft, the loading screen may not close automatically.

Agent

Mod Loading Screen includes a Java agent that allows launching the loading screen even before the mod loader itself loads. This feature is particularly useful for modpack developers aiming to create a seamless loading experience. To use the agent, add the parameter -javaagent:mod-loading-screen-1.0.4.jar to JVM arguments. When using the agent, the mod itself should not be installed.

API

To connect the API, use Modrinth Maven. The API should be JiJ'ed, which will exclude the entire Mod Loading Screen from being included in your mod (only the API, which is a few kilobytes in size, will be added). The API is designed with forward and backward binary compatibility with future Mod Loading Screen versions. There's a capability to check which API calls return stubs and which ones are real functions.

repositories {
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup("maven.modrinth")
        }
    }
}

dependencies {
    // implementation, not modImplementation!
    include(implementation("maven.modrinth:mod-loading-screen:1.0.4:api"))
}

The API contains two main classes: LoadingScreenApi and AvailableFeatures. Complete javadocs documentation is available for both classes.