JelloUI API overview

This document set describes the public API of JelloUI, the UI platform mod that powers Jello-style screens, ClickGUI content, HUDs, notifications, themes, animation, profiles, keybinds and world-space markers in Minecraft.

The documentation is written for third-party mod authors who want to contribute modules and supported services to the platform. It is not a class-by-class dictionary; it explains the contracts that matter when you integrate an addon, including current surfaces that are declared publicly but not yet wired end to end.

What JelloUI is

JelloUI is a client-side Fabric prerequisite mod. It contains no gameplay modules of its own. Addons contribute content through a stable public API. Some public definitions are metadata-only or are not wired end to end yet; the surface-specific chapters call out those limits explicitly.

The JelloUI Official Addon is a separate Fabric project that registers the first-party GUI-category modules (ActiveMods, BrainFreeze, Coords, Compass, MiniMap, KeyStrokes, MusicParticles, TabGUI) through the same public API. The example project contains public API demos as well as migrated first-party feature sources; its API-only boundary is explained in 08-example-mod.

The stable surface

All public API types live under io.github.sst.remake.api. That package is the stable contract you can depend on. Everything under io.github.sst.remake.internal is private and can change at any time.

The entry point is the singleton JelloApi, which exposes these registries and services:

• categories() - ClickGUI category panels
• modules() - modules with settings, lifecycle and live state
• hud() - HUD widgets
• keybinds() - keybind definitions and bindings
• notifications() - the notification stack
• theme() - theme tokens and the active theme
• renderListeners() - per-phase render callbacks
• components() - custom screen provider registration; opening is not wired in the current core
• profiles() - profile section codecs and templates

Separately, JelloWorldMarkers is a static facade for world-space marker rendering. It does not require a registration and is not behind the singleton.

The reading order

The rest of this directory follows the path an addon author actually walks:

1. 01-addon-lifecycle - how addons attach to the platform
2. 02-registration - identity and ownership
3. 03-modules - modules, settings, lifecycles
4. 04-surfaces - HUD, render, keybinds, notifications, components
5. 05-profiling - profiles and persistence
6. 06-world-markers - caller-supplied world rendering
7. 07-compatibility - versioning and boundaries
8. 08-example-mod - the example addon as a reference

The *DemoModule classes under example-mod/src/main/java/io/github/sst/remake/example/ are a compile-checked companion to this guide. ExampleModAddon also wires migrated first-party features through legacy imports, so neither that entry point nor the artifact as a whole is an import allowlist for third-party addons.