ModSettingsMenu

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

說明：本描述爲中英雙語版本，中文內容位於英文內容下方。

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! / 如果你喜歡我的模組，請支持我一下吧！

 

Mod Settings Menu (中文)

在遊戲中添加模組配置菜單，無需向模組註冊即可顯示配置項，支持 模組更新檢查，模組配置項本地化和用於模組作者的可選自定義元數據。

主要功能

• 左側顯示可配置的模組名稱，右側顯示當前選中模組的設置項。
• 自動顯示已加載 BepInEx 模組的配置項，無需向模組設置菜單註冊。
• 模組作者可以選擇註冊顯示名稱、簡介、作者、版本、 ID 和 包信息。
• 通過守墓人 2 本地化 API 支持自行翻譯文本，未提供翻譯的模組也可使用。

給玩家

本模組不會自行修改遊戲玩法，只爲兼容的模組提供統一設置界面。

列表中會顯示已經加載並且至少包含一個配置項的模組。模組設置菜單自身也會顯示模組信息。實際可用設置由你安裝的其他模組決定。

配置文本本地化

• 在遊戲中打開一次模組設置。菜單會在 BepInEx/config/ModSettingsMenu.Localization 中爲每個模組生成.json，只包含遊戲當前語言的文本。
• 打開想翻譯的模組 JSON 文件，修改當前語言代碼（如 zh_cn 或 en）下的文本值；不要修改語言代碼和鍵名。
• 保存文件，關閉並重新打開模組設置。菜單會顯示翻譯後的模組名稱、分類、配置項名稱、說明和支持的選項文本。

生成的文本初始值爲模組當前顯示的文字，未翻譯時也不會留空。切換遊戲語言後重新打開菜單，會補入該語言及缺失項，保留已有譯文。內置的開啓/關閉文本和按鍵名稱無需翻譯。遊戲不支持的語言可填寫在 en 等已有遊戲語言節，再在遊戲中選擇對應語言；這隻替換模組配置文本，不會新增遊戲語