ModSettingsMenu

Note: This description is bilingual. The Chinese section is provided below the English section.

Note: This description is a bilingual version in Chinese and English. The Chinese content is located below the English content.

Mod Settings Menu (English)

Adds an in-game Mod Settings menu that displays configuration options without requiring mod registration. Supports update checks, localization of mod settings, and optional custom metadata for mod authors.

Main Features

• Shows configurable mod names on the left and the selected mod's settings on the right.
• Automatically displays configuration entries from loaded BepInEx mods without requiring registration with Mod Settings Menu.
• Lets mod authors optionally register a display name, description, author, version, ID, and package.
• Supports author-provided HTTPS update manifests, with update status shown to the right of the mod metadata.

For Players

This mod does not change gameplay by itself. It provides a common settings screen for compatible mods.

Loaded mods with at least one configuration entry appear in the list. Mod Settings Menu itself also appears with its metadata. The available settings depend on the mods you have installed.

Config Text Localization

• Open Mod Settings in the game once. For each mod, a.json file is created in BepInEx/config/ModSettingsMenu.Localization with entries for the current game language.
• Open the JSON file for the mod you want to translate. Edit the text values under the current language code, such as zh_cn or en. Keep the language codes and keys unchanged.
• Save the file, then close and reopen Mod Settings to load your changes. The translated mod name, categories, setting names, descriptions, and supported choice labels appear in the menu.

The generated values start with the mod's current displayed text, so they are usable before translation. Switching the game language and reopening the menu adds that language and any missing keys without overwriting existing translations. Built-in on/off text and key names are not translation entries. To use a language the game does not support, put its translation under en or another existing game language and select that language in the game; this changes mod setting text only.

Mod Author API

• Registration is optional. A loaded BepInEx plugin with normal Config.Bind entries is detected automatically.
• Use ModSettingsRegistry.Register only when you want to provide custom metadata or and links.
• Set UpdateManifestUrl to an HTTPS JSON version manifest to show update status in this edition. Update checks only report status and never download files.
• This edition does not search by mod name or query registered IDs automatically.
• Use ModSettingsTags.Section and ModSettingsTags.Entry in ConfigDescription for display metadata, ordering, and custom slider steps. Lower order values appear first; unspecified values use 1000.
• Example mods for reference: Graveyard Keeper 2 example mods

Compatibility

• Game Version: 1.007+

Bug Reports & Feature Suggestions

If you have any questions or feature suggestions, please submit them through GitHub Issues, contact me on Discord at iceboxcool, or email me at 764884112@qq.com or ibox2333@gmail.com.

If you enjoy my mods, feel free to support me! / If you like my mods, please support me!

 

Mod Settings Menu (Chinese)

在游戏中添加模组配置菜单，无需向模组注册即可显示配置项，支持 模组更新检查，模组配置项本地化和用于模组作者的可选自定义元数据。

Main functions

• The left side displays the configurable module name, and the right side displays the settings of the currently selected module.
• Automatically display configuration items of loaded BepInEx modules without registering to the module settings menu.
• Mod authors can choose to register to display name, introduction, author, version, ID and package information.
• Supports self-translation of text through the Gravekeeper 2 localization API, which can also be used by mods that do not provide translation.

to players

This module will not modify the gameplay on its own, but on …