Back to 9Minecraft
Wiki 9Minecraft Wiki 9Minecraft
Mod Menu Badges Lib Wiki › Guides › Using Mod Menu Badges Lib as a Dependency in Your Mod Project

Using Mod Menu Badges Lib as a Dependency in Your Mod Project

Declaring the Dependency

Because this is a library, your mod does not bundle it; players install it alongside your mod. In your build configuration, declare Mod Menu Badges Lib as a dependency so your code can compile against its API. You should also declare Mod Menu itself, since the badges only have somewhere to render when Mod Menu is present.

Guarding Against Absence

Players may run your mod without Mod Menu installed. If your badge registration code runs unconditionally, it can crash on startup. Wrap the registration in a check that confirms Mod Menu is loaded before calling into the badge API, or use your loader's optional-dependency mechanism so the registration only happens when the library is available. This keeps your mod usable for players who do not use Mod Menu at all.

Documenting It for Players

On your mod's description, list Mod Menu Badges Lib as a required or optional dependency and explain what the badge communicates. Players who see a badge they do not understand will look for an explanation, and the tooltip is the right place for it. Keep the tooltip wording consistent with how you describe the badge in your mod description.