Skip to content

Cardistymo/ModMenu

 
 

Repository files navigation

ModMenu

Hard to be more descriptive than that. It enriches the standard Minecraft menu with an interface displaying a one-dimensional array of modifications

A picture's worth 2 words

Developers:

"custom": {
    "modmenu": {
        "badges": [] // available badges: library, deprecated
        "parent": { // may be the parent's mod id or an object that provides all necessary infos 
            "id": "awesome-parent",
            "name": "Awesome Parent",
            "description": "An awesome parent, what do else do you expect?",
            "icon": "assets/child/awesome_parent_icon.png",
            "badges": [ "client" ]
        }
    }
}
  • Mod parenting is used to display a mod as a child of another one. This is meant to be used for mods divided into different modules. The following element in a fabric.mod.json will define the mod as a child of the mod 'flamingo':
"custom": {
    "modmenu": {
        "parent": "flamingo"
    }
}
  • ModMenuAPI
    • To use the API, implement the ModMenuApi interface on a class and add that as an entry point of type "modmenu" in your fabric.mod.json as such:
    "entrypoints": {
      "modmenu": [ "com.example.mod.ExampleModMenuApiImpl" ]
    }
    • Features
      • Mods can provide a Screen factory to provide a custom config screen to open with the config button. Implement the getConfigScreenFactory method in your API implementation.
      • Mods can provide additional mods to be displayed on the mods list.
      • Mods can provide additional parenting rules.

Releases

No releases published

Packages

No packages published

Languages

  • Java 99.8%
  • Python 0.2%