Skip to content

Repository files navigation

Versions Downloads Downloads

About the Mod

FluxLoading is a mod that enhances immersion by capturing a screenshot of the logout screen and displaying it when you reload your world. When you rejoin, you'll see the exact scene from where you left off, smoothly fading out into real-time gameplay.

ezgif-1359521c68cdd9

Core Design

FluxLoading is built around three separated subsystems:

  • Finite State Machine: loading phase control
  • Timeline: time-based animation and transition sequencing (fade-in / wait / fade-out)
  • Chunk Gate: decision logic that determines whether extra chunk loading is required before releasing control

Loading Phases

graph TD
    A[FADING_IN]
    A --> B[DEFAULT_WORLD_LOADING]
    B --> C[EXTRA_CHUNK_LOADING]
    C --> D[EXTRA_WAIT]
    D --> E[FADING_OUT]
    E --> F[FINISHED]
Loading

Note:
Chunk loading may be waited (EXTRA_CHUNK_LOADING) to smoothen the fade-out effect (the decision is made by the Chunk Gate)

Addon & Integration Guidelines

Detecting FluxLoading

if (FluxLoadingAPI.isActive())
{
    // FluxLoading is currently controlling the loading screen
}

Observing Phases

FluxLoadingPhase phase = FluxLoadingAPI.getPhase();

Lifecycle Hooks

FluxLoadingAPI.addFluxLoadingStartListener(() -> { ... });
FluxLoadingAPI.addFluxLoadingTickListener(() -> { ... });
FluxLoadingAPI.addFluxLoadingEndListener(() -> { ... });

Player Lock

During loading (EXTRA_CHUNK_LOADING or EXTRA_WAIT to be exact):

  • Player input is locally locked
  • Position is locked both client-side and server-side
  • Server-side enforcement is supported via packets

Dependency

  • mixinbooter 10.0+

Build Locally

Download and add the following libs to ./libs:

  • celeritas-common-2.3.0-dev.3.jar
  • Hwyla-1.8.26-B41_1.12.2.jar
  • OpenTerrainGenerator-1.12.2-v9.5-R2.jar

Compatibility

About

A mod for seamless world loading screen

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages