Cumulus — Guide
Which Mods Need It
Install Cumulus whenever a mod lists it as a dependency (mod id cumulus_menus). Without it, those mods will fail to load.
- The Aether series uses Cumulus to provide its themed main menus.
- Any other mod that adds a custom title-screen/main-menu layout through this framework needs it.
If no installed mod requires a custom menu, you do not need Cumulus.
Developer API
Cumulus is consumed by other mods as a dependency (mod id cumulus_menus).
Adding it to a dev environment (Gradle): declare a modImplementation dependency on the Cumulus artifact that matches your Minecraft version and loader, and add the matching Maven repository. Reference the mod id cumulus_menus in your mod metadata so load order is enforced.
Key entry points (package root com.aetherteam.cumulus):
- com.aetherteam.cumulus.api - the menu API used to register and describe custom menus.
- com.aetherteam.cumulus.client - the client-side menu screens and rendering hooks.
- Menus registered through the API appear in the game's menu-selection option, so players can switch between installed menus.
See the upstream Cumulus documentation for full API details and current version coordinates.