Mod Menu para Minecraft 1.20.1, 1.21.1

Mod Menu

Mod Menu te permite ver los mods que tienes instalados y, si el mod lo admite, ofrece acceso rápido y sencillo a las pantallas de configuración del mod.

Mod Menu también admite algunas funciones más avanzadas, como nombres y descripciones de mods traducibles, compatibilidad con el formato QuickText en las descripciones de los mods gracias a la Text Placeholder API de Patbox, filtra los mods de biblioteca de los mods normales, un comprobador de actualizaciones para mods alojados en Modrinth o que proporcionan sus propias fuentes de actualización, y una configuración profunda para todas las funciones que ofrecemos.

Plataformas compatibles

Mod Menu está disponible actualmente para Fabric o Quilt en Minecraft: Java Edition 1.14 o posterior.

Desarrolladores

Mod Menu incluye varias API para que los desarrolladores mejoren cómo aparece su mod en Mod Menu. Estas vienen en forma de claves de idioma, metadatos JSON e incluso una API de Java.

API de traducción

Puedes traducir el nombre, el resumen y la descripción de tu mod sin tocar ningún código Java. Solo tienes que añadir claves de traducción en el formato compatible a cualquier idioma que quieras.

Documentación de la API de traducción

Aquí tienes un ejemplo de las traducciones de Mod Menu al habla pirata. Para crear las tuyas, solo tienes que reemplazar modmenu al final (NO el del principio) de la clave de traducción por tu propio ID de mod, por ejemplo modmenu.descriptionTranslation.traverse.

enpt.json

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

La traducción del resumen es redundante aquí y no es necesario incluirla porque es igual que la descripción, pero se incluyó para mostrar que puedes traducir el resumen (una descripción breve de una frase del mod) por separado de la descripción, ¡incluso en inglés!

API de metadatos de Fabric

Hay varias cosas que puedes añadir solo con metadatos en tu fabric.mod.json.

Todas ellas se añaden a un bloque personalizado en tu fabric.mod.json para los metadatos de Mod Menu. Aquí tienes un ejemplo de uso de muchas de las funciones que proporciona esta API:

fabric.mod.json

{ ... "custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" }, "badges": [ "library", "deprecated" ], "parent": { "id": "example-api", "name": "Example API", "description": "Modular example library", "icon": "assets/example-api-module-v1/parenticon.png", "badges": [ "library" ] }, "updatechecker": true } } }

Documentación de la API de metadatos de Fabric

Insignias ("badges": [ ])

Aunque la insignia Client se añade automáticamente a los mods configurados como solo para el cliente (establece "environment": "client" en fabric.mod.json para hacerlo), otras insignias como las de Library y Deprecated requieren definirse aquí.

Valores compatibles:

• library - debe asignarse a mods que son puramente dependencias de otros mods y que no deberían mostrarse al usuario de forma predeterminada a menos que las activen.
• deprecated - debe asignarse a mods que existen puramente por motivos de legado, como un módulo de API antiguo o similar.

Cualquier otro valor se ignorará, y Mod Menu no admite añadir tus propias insignias. Puedes abrir una incidencia aquí si tienes un caso de uso convincente para una nueva insignia.

Enlaces ("links": { })

El objeto links permite a los autores de mods añadir hipervínculos personalizados al final de su descripción. Si especificas un contacto de sources en los metadatos oficiales de fabric.mod.json, también se incluirá en la sección de enlaces.

Cualquier clave del objeto links se incluirá en la sección de enlaces, y la clave se usará como clave de traducción. Por ejemplo, esto:

fabric.mod.json

"custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" } } }

se mostrará como un enlace con el texto "Discord", ya que "Discord" es la traducción al inglés de "modmenu.discord" proporcionada por Mod Menu.

Mod Menu proporciona varias traducciones predeterminadas que se pueden usar para los enlaces. Puedes ver una lista completa en el archivo de idioma de Mod Menu aquí. Todas las claves de traducción de enlaces predeterminadas tienen la forma modmenu..

También puedes proporcionar tus propias traducciones si quieres añadir enlaces personalizados. Asegúrate de usar tu propio espacio de nombres (en lugar de modmenu) para cualquier clave personalizada.

Padres ("parent": "modid" o { })

Los padres se usan para mostrar un mod como hijo de otro. Esto está pensado para mods divididos en diferentes módulos. El siguiente elemento en un fabric.mod.json definirá el mod como hijo del mod 'flamingo':

fabric.mod.json

"custom": { "modmenu": { "parent": "flamingo" } }

Sin embargo, si quieres agrupar mods bajo un padre, pero el padre no es un mod real, también puedes hacerlo. En el ejemplo de abajo, un mod está definiendo metadatos para un padre. Asegúrate de que estos metadatos se incluyan en todos los hijos que usen el padre falso/ficticio. Esto también se puede usar como respaldo para un padre opcional; será reemplazado por los metadatos reales del mod si están presentes.

fabric.mod.json

"custom": { "modmenu": { "parent": { "id": "this-mod-isnt-real", "name": "Fake Mod", "description": "Do cool stuff with this fake mod", "icon": "assets/real-mod/fake-mod-icon.png", "badges": [ "library" ] } } }

Los mods padre ficticios solo admiten los siguientes metadatos:

• id (String)
• name (String)
• description (String)
• icon (String)
• badges (Array of Strings)

Desactivar el comprobador de actualizaciones ("updatechecker": false)

De forma predeterminada, el comprobador de actualizaciones de Mod Menu usará el hash del jar de tu mod para buscar la última versión en Modrinth. Si encuentra un proyecto coincidente, comprobará la última versión que admita tu cargador de mods y tu versión de Minecraft, y si tiene un hash diferente al de tu archivo existente, avisará al usuario de que hay una actualización disponible.

Puedes desactivar el comprobador de actualizaciones estableciendo updatechecker en false en tus metadatos de Mod Menu así:

fabric.mod.json

"custom": { "modmenu": { "updatechecker": false } }

API de metadatos de Quilt

Como Mod Menu también admite Quilt, las mismas API de la sección de la API de metadatos de Fabric también están disponibles para los mods de Quilt, pero el formato de los metadatos personalizados es ligeramente diferente.

En lugar de un bloque "modmenu" dentro de un bloque "custom", pones el bloque "modmenu" como elemento en el objeto raíz. Así que debería verse así:

quilt.mod.json

{ ... "modmenu": { // Aquí es donde van tus enlaces, insignias, etc. } }

API de Java

Para usar la API de Java, tendrás que añadir Mod Menu como dependencia en tiempo de compilación en tu proyecto de gradle. Esto no hará que tu mod requiera Mod Menu, pero estará presente en tu entorno para que puedas probarlo.

build.gradle

// Add the Terraformers maven repo to your repositories block repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Add Mod Menu as a dependency in your environment dependencies { // Prior to Minecraft 26.x, use "modImplementation" instead implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Después, define la versión de Mod Menu que estás usando en tu gradle.properties. Puedes obtener el número de la última versión aquí, pero es posible que necesites una versión diferente si no usas la última versión de Minecraft. Consulta la página de versiones para ver una lista completa de versiones.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Si no la quieres en tu entorno para probar pero aún así quieres compilar contra Mod Menu para usar la API de Java, puedes usar modCompileOnly en lugar de modImplementation (esto funcionará incluso si Mod Menu no está actualizado a la versión de Minecraft que estás usando).

Documentación de la API de Java

Primeros pasos

Para usar la API, implementa la interfaz ModMenuApi en una clase y añádela como punto de entrada de tipo "modmenu" en tu fabric.mod.json así:

fabric.mod.json

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

Pantallas de configuración de mods

Los mods pueden proporcionar una fábrica de Screen para ofrecer una pantalla de configuración personalizada que se abra con el botón de configuración. Implementa el método getModConfigScreenFactory en tu implementación de la API para hacerlo.

El caso de uso previsto para esto es que los mods proporcionen sus propias pantallas de configuración. El ID del mod de la pantalla de configuración se determina automágicamente por el contenedor del mod de origen del que proviene el punto de entrada.

Pantallas de configuración proporcionadas

Los mods pueden proporcionar fábricas de Screen para ofrecer pantallas de configuración personalizadas que se abran con los botones de configuración de otros mods también. Implementa el método getProvidedConfigScreenFactories en tu implementación de la API para esto.

El caso de uso previsto para esto es que un mod como Cloth Config proporcione pantallas de configuración para los mods que usan su API.

Insignias de modpack

Los mods pueden dar a otros mods la insignia de Modpack implementando el método attachModpackBadges, como por ejemplo mediante lo siguiente:

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

Ten en cuenta que los mods 'internal' como el propio Minecraft y el cargador de mods no pueden recibir la insignia de modpack, ya que no se distribuyen dentro de un modpack típico.

Métodos auxiliares estáticos

ModMenuApi también ofrece algunos métodos auxiliares para los mods que quieren funcionar mejor con Mod Menu, como crear sus propios botones de Mods.

Crear una instancia de la pantalla de Mods

Puedes llamar a este método para obtener una instancia de la pantalla de Mods:

Screen createModsScreen(Screen previous)

Crear un Text de botón de Mods

Puedes llamar a este método para obtener el Text que se mostraría en un botón de Mods de Mod Menu:

Text createModsButtonText()