The example addon as a reference

example-mod/ contains a compile-checked set of public API demonstrations in io.github.sst.remake.example. That package is the companion to these docs.

The artifact is not a pure third-party boundary example: its Gradle source set also packages migrated non-GUI Sigma/Jello feature modules and RearView, and ExampleModAddon reaches legacy Client, ModuleManager, Module and Setting classes to register them. Third-party addons must not copy those imports or the migrated-module registration path.

What it covers

Every demo module lives in one ClickGUI category displayed as Example Mod, so a human can open the ClickGUI, find the panel and toggle each API surface in action.

Module	API surface
Settings	every SettingDefinition type, visibility predicates, action buttons, custom renderer, live SettingHandle, StateAdapter
Notifications	NotificationSink, all NotificationTypes and NotificationRequest builder; key metadata is demonstrated but not consumed by the current bridge
Keybinds	KeybindRegistry, keyboard/mouse/unbound InputBinding, KeybindAction TOGGLE/HOLD and module binding
HUD	HudRegistry, HudWidget, HudAnchor, preferred size, visibility predicate, renderer
Render Listeners	RenderListenerRegistry, all three RenderPhases, priority, unregister
World Markers	JelloWorldMarkers: Sims, box outline, skeleton, vanilla glow
Theme / Profile / Screen	ThemeRegistry, ProfileRegistry + ProfileSectionCodec + ProfileTemplate; component registration plus the current failed-open path
Animation	AnimationSpec builder, Easings curves, easing evaluation
Error Isolation	ErrorIsolators, ApiErrorHandler, ApiError types, ApiVersion

The addon also registers a custom theme, a profile section codec and a custom component screen from its entry point, covering the global non-module registries.

Reading the code

Start with ExampleIds for centralized ids, then the create method on each *DemoModule class for one surface end to end. In ExampleModAddon#initializeJelloAddon, the category, public module, theme, profile and component registrations are relevant; skip registerMigratedFeatureModules and any helper that reads legacy module state.

Human testing

Run the client with the JelloUI jar and the example jar installed, open the ClickGUI and use the Example Mod panel. Work through the API surfaces in the table above and watch the on-screen notifications and game log for feedback. The source checkout also contains a more detailed testing guide in example-mod/README.md. The example prints a startup notification listing how many modules it registered.

For API boundary review, restrict inspection to imports under io.github.sst.remake.api in the demo classes. The artifact-wide import set is intentionally broader and is not an allowed third-party dependency list.