模组配置菜单(生活质量)

模组配置菜单(生活质量)

ModConfigMenu (MCM) — 直接在游戏内设置模组

需要 RE_Kenshi。

游戏选项窗口中的一个 MCM 标签页:直接在游戏中设置 RE_Kenshi 插件,使用游戏自身的行样式绘制,即时生效。并为插件作者提供 SDK。

游戏内文本跟随游戏语言:英语、俄语或中文。

版本 5

功能

所有模组设置——直接在游戏中。选项窗口(主菜单或游戏中按 Esc)会多出一个 MCM 标签页:

  • 左侧 - 有设置的模组;
  • 右侧 - 所选模组的设置,使用与游戏其余部分相同的行样式绘制:复选框、带数字字段的滑块、选项和按键按钮、文本字段、颜色——从调色板或代码中选择;
  • 底部 - 光标所在行的提示;
  • 窗口标题 - 所选模组的名称。

更改会立即保存并应用。标有星号(*)的行在游戏重启后生效。页面底部的“重置为默认值”按钮会恢复该模组的所有值。

哪些模组

任何支持 MCM 的 RE_Kenshi 插件。已支持:

  • 我们的模组: Live Xp Bars, Stat Colours, Gear Compare Alt, Assigned Workers, UI Tweaks, Patient Self Aid, Wanted Map, Build Mode Gizmo, Ranged Damage Xp, Quick Start Select;
  • 我们对 Emkej8 模组的分支: Auto-Pause on Load, Container Highlight, Hidden Faction Relations, Job B Gone, Loot Scoot Execute, Map markers, Organize the Crafting Stations, Organize the Trader, Vital Read, Vital Sense, Wall B Gone。

MCM 对它们全部都是可选的:没有 MCM 时,它们的设置像以前一样保留在各自的文件中。

面向插件作者

插件不依赖 MCM:其设置保留在 ini 中。要在标签页中显示,插件需导出一个函数——MCM_Describe——并在其中描述其设置:

  • 开关、整数和小数、选项、文本、快捷键、颜色(调色板);
  • 基于自定义函数的行——适用于将设置保存在 ini 以外位置的插件;
  • 页面上自己的区域——用于自己的控件(列表、表格);
  • 列表中模组的提示以及重置按钮的默认值。

MCM 会自动查找插件,模组加载顺序无关紧要。所需的一切都在模组的 sdk 文件夹中:ModConfigMenu.h 头文件以及英语、俄语和中文指南(MCM_API_en.md、MCM_API_ru.md、MCM_API_zh.md)。包含适用于基于 Emkej's Mod Hub 构建的模组的桥接文件——McmModHubBridge.h。

源代码

MCM 和我们其他插件的源代码——LEOPARD-Kenshi-Plugins,我们对 Emkej8 及其他作者模组的分支源代码——LEOPARD-Kenshi-Forks(GitHub)。


Русский

Требуется RE_Kenshi.

Текст в игре - на языке игры: английском, русском или китайском.

Версия 5

ЧТО ДЕЛАЕТ

Все настройки модов - прямо в игре. В окне «Настройки» (главное меню или Esc в игре) появляется вкладка MCM:

  • слева - моды, у которых есть настройки;
  • справа - настройки выбранного мода, теми же строками, что во всей игре: флажки, ползунки с полем для числа, кнопки выбора и клавиш, поля ввода, цвета - из палитры или кодом;
  • внизу - подсказка к строке под курсором;
  • в заголовке окна - название выбранного мода.

Изменение сразу сохраняется и применяется. Строки со звёздочкой (*) действуют после перезапуска игры. Кнопка «Сбросить по умолчанию» внизу страницы возвращает все значения мода.

КАКИЕ МОДЫ

Любой плагин RE_Kenshi, который поддерживает MCM. Уже умеют:

  • наши моды: Live Xp Bars, Stat Colours, Gear Compare Alt, Assigned Workers, UI Tweaks, Patient Self Aid, Wanted Map, Build Mode Gizmo, Ranged Damage Xp, Quick Start Select;
  • наши форки модов Emkej8: Auto-Pause on Load, Container Highlight, Hidden Faction Relations, Job B Gone, Loot Scoot Execute, Map markers, Organize the Crafting Stations, Organize the Trader, Vital Read, Vital Sense, Wall B Gone.

Для всех них MCM не обязателен: без него настройки остаются в их файлах, как раньше.

ДЛЯ АВТОРОВ ПЛАГИНОВ

Плагин от MCM не зависит: настройки остаются в его ini. Чтобы появиться во вкладке, плагин экспортирует одну функцию - MCM_Describe - и описывает в ней свои настройки:

  • флажки, целые и дробные числа, варианты на выбор, текст, клавиши, цвета (палитра);
  • строки на своих функциях - для плагинов, которые хранят настройки не в ini;
  • своя область на странице - для своих виджетов (списки, таблицы);
  • подсказка к моду в списке и значения по умолчанию для кнопки сброса.

MCM находит плагины сам, порядок загрузки модов не важен. Всё нужное - в папке sdk мода: заголовок ModConfigMenu.h и руководство на английском, русском и китайском (MCM_API_en.md, MCM_API_ru.md, MCM_API_zh.md). Для модов на Emkej's Mod Hub есть готовый мост - McmModHubBridge.h.

ИСХОДНИКИ

Исходный код MCM и остальных наших плагинов - LEOPARD-Kenshi-Plugins, наших форков модов Emkej8 и других авторов - LEOPARD-Kenshi-Forks (GitHub).