Mod Menu Documentation

To use the Java API, add Mod Menu as a compile-time dependency in your build.gradle.

1. Add the Terraformers Maven repository.
2. Add the dependency using implementation (for testing in your environment) or modCompileOnly (to compile against it without requiring it as a runtime dependency).

// build.gradle
repositories {
  maven {
    name = "Terraformers"
    url = "https://maven.terraformersmc.com/"
  }
}

dependencies {
  // Use modImplementation for testing, or modCompileOnly for compilation only
  implementation("com.terraformersmc:modmenu:${project.modmenu_version}")
}

# gradle.properties
modmenu_version=VERSION_NUMBER_HERE

You can translate your mod's name, summary, and description without changing Java code by adding translation keys to your language files.

To translate a specific mod, use the format modmenu.<type>Translation.<your_mod_id>.

Supported types:

• nameTranslation (for the mod name)
• descriptionTranslation (for the full description)
• summaryTranslation (for a short, one-sentence description)

Example for a mod with ID traverse in Pirate Speak:

{
    "modmenu.nameTranslation.traverse": "Menu o' mods!",
    "modmenu.descriptionTranslation.traverse": "Menu o' mods ye installed matey!",
    "modmenu.summaryTranslation.traverse": "Menu o' mods ye installed matey!"
}

For Quilt mods, the modmenu configuration block is placed at the root of the quilt.mod.json file instead of inside a custom block.

{
  "modmenu": {
    // Configuration keys like links, badges, etc. go here
  }
}

To use the Java API, implement the ModMenuApi interface on a class and register it as a modmenu entrypoint in your fabric.mod.json.

"entrypoints": {
  "modmenu": [ "com.example.mod.ExampleModMenuApiImpl" ]
}

The ModMenuApi interface provides helper methods for creating UI elements related to Mod Menu:

• createModsScreen(Screen previous): Returns an instance of the Mods screen.
• createModsButtonText(): Returns the Text object used for the Mod Menu 'Mods' button.

You can grant the Modpack badge to your mod (indicating it is part of a modpack) by implementing attachModpackBadges in your ModMenuApi implementation.

@Override
public void attachModpackBadges(Consumer<String> consumer) {
    consumer.accept("modmenu"); // Indicates that 'modmenu' is part of the modpack
}

Implement ModMenuApi to allow users to access your mod's config screens directly from Mod Menu.

• getModConfigScreenFactory: Use this to provide a Screen factory for your own mod's configuration.
• getProvidedConfigScreenFactories: Use this if your mod provides configuration screens for other mods (e.g., a config library like Cloth Config).