Cumulus Wiki

Cumulus is a library for building custom title-screen and main-menu layouts in Minecraft. It provides a flexible menu framework that lets mods define alternative main menus, backgrounds, panorama scenes, and layouts, and lets players choose which menu they want from the options screen.

Cumulus is a dependency library with no player-facing content of its own - it adds no blocks, items, or gameplay. It only does something when a mod uses it to register a custom menu. Its mod id is cumulus_menus.

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.

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.

What does Cumulus do on its own? Nothing beyond enabling custom menu selection - it is a library for other mods.

A mod says it needs Cumulus - what do I do? Add Cumulus to your mods folder alongside that mod.

I get a missing-dependency error for cumulus_menus. A mod needs Cumulus but it is not installed; add it so the mod can load.

How do I switch menus? Once a mod registers a menu through Cumulus, pick it from the game's menu/options selection.

Do I need it if no mod asks for it? No - it only matters when a mod requires a custom menu.