Outward Config Manager

Внешняя версия

Это версия BepInEx. ConfigurationManager предназначен для использования с внешним интерфейсом. Он был разветвлен с версии 16.1 и имеет все изменения до 16.3. (BepInEx.ConfigurationManager)

Как использовать:

• Во время игры нажмите F5, чтобы открыть менеджер конфигураций.
• Вы можете изменить связку ключей, отредактировав файл BepInEx\config\io.mefino.configurationmanager.cfg

Запись выпуска

17.2:

• Обновлено для Definitive Edition

17.1:

• Исправлена проблема с некоторыми модами, не показывающими свои настройки

17.0:

• Добавлена поддержка «отклоняющихся» файлов конфигурации, которые не связаны непосредственно с плагином
• Добавлено событие для прослушивания конфигурационных файлов, созданных после процесса Chainloader
• Удалена поддержка BepInEx 4 (не имеет отношения к Outward)

16.3.3:

• Изменения в верхнем течении от 16.2 и 16.3

Как пользоваться (ручная установка)

• Установите пакет Outward BepInEx. (Outward BepInEx Pack)
• Скачайте последнюю версию со вкладки Releases выше.
• Поместите плагины / файл ConfigurationManager.dll в папку BepInEx / плагины.
• Поместите патчеры / конфигурационный менеджер. Файл Patcher.dll в папке BepInEx/patchers/.
• Начните игру и нажмите F5.

Оригинал Readme

Из официального репо. (the official repo)

Менеджер конфигурации плагинов / модов для BepInEx 5

Простой способ позволить пользователю настроить поведение плагина без необходимости создавать свой собственный графический интерфейс. Пользователь может изменить любые настройки, которые вы предоставляете, даже ярлыки клавиатуры.

К менеджеру конфигурации можно получить доступ в игре, нажав клавишу hotkey (по умолчанию F5). Нажмите на имена, чтобы увидеть их описания, если таковые имеются.

Как сделать мод совместимым?

ConfigurationManager автоматически отображает все настройки из Config вашего плагина. Все метаданные (например, описание, диапазон значений) будут использоваться ConfigurationManager для отображения настроек пользователю.

В большинстве случаев вам не нужно обращаться к ConfigurationManager. Делайте или делайте что-то особенное с вашими настройками. Просто добавьте как можно больше метаданных (это поможет всем пользователям, даже если они используют файлы конфигурации напрямую). Всегда добавляйте описательный раздел и ключевые имена, описания и приемлемые списки значений или диапазоны (где это применимо).

Как сделать мою установку в слайдер?

Укажите допустимую величину при создании настройки. Если диапазон равен 0f - 1f или 0 - 100, то слайдер будет отображаться как % (это может быть переопределено ниже).

CaptureWidth = Config.AddSetting("Section", "Key", 1, new ConfigDescription("Description", new AcceptableValueRange(0, 100)));

Как сделать мою настройку в выпадающий список?

Укажите допустимую ценность при создании настройки. Если вы используете список, вам не нужно указывать AcceptableValueList, все значения числа будут показаны. Если вы хотите скрыть некоторые ценности, вам придется использовать атрибут.

Примечание: Вы можете добавить систему. Компонентная модель. Относитесь к элементам вашего списка, чтобы переопределить их отображаемые имена. Например:

public enum MyEnum
{
    // Entry1 will be shown in the combo box as Entry1
    Entry1,
    [Description("Entry2 will be shown in the combo box as this string")]
    Entry2
}

Как позволить пользователю изменить мою клавиатуру Как легко проверить нажатия клавиш?

Добавить настройку типа KeyboardShortcut. Используйте значение этого параметра для проверки входных данных (рекомендуйте использовать IsDown) в вашем методе обновления.

Класс KeyboardShortcut поддерживает клавиши модификатора - Shift, Control и Alt. Они должным образом обрабатываются, предотвращая общие проблемы, такие как K+Shift+. Контроль запуска K+Shift, когда его не должно быть.

private ConfigEntry ShowCounter { get; set; }

public Constructor()
{
    ShowCounter = Config.AddSetting("Hotkeys", "Show FPS counter", new KeyboardShortcut(KeyCode.U, KeyCode.LeftShift));
}

private void Update()
{
    if (ShowCounter.Value.IsDown())
    {
        // Handle the key press
    }
}

Преобладающее поведение Configuration Manager по умолчанию

Вы можете изменить способ отображения настройки в окне менеджера конфигурации, пройдя экземпляр специального класса в качестве тега настройки. Специальный код класса можно скачать здесь. Просто загрузите файл .cs и перетащите его в свой проект.

• Вам не нужно ссылаться на ConfigurationManager.dll, чтобы это работало.
• Класс будет работать до тех пор, пока название класса и декларации его полей остаются неизменными.
• Избегайте публичного использования класса для предотвращения конфликтов с другими плагинами. Если вы хотите поделиться им между своими плагинами, либо дайте каждому копию, либо переместите ее в свое собственное пространство имен.
• Если плагин ConfigurationManager не установлен в игре, этот класс будет безопасно проигнорирован, и ваш плагин будет работать как обычно.

Вот пример основного порядка настроек и маркировки одной из настроек как продвинутой:

// Override IsAdvanced and Order
Config.AddSetting("X", "1", 1, new ConfigDescription("", null, new ConfigurationManagerAttributes { IsAdvanced = true, Order = 3 }));
// Override only Order, IsAdvanced stays as the default value assigned by ConfigManager
Config.AddSetting("X", "2", 2, new ConfigDescription("", null, new ConfigurationManagerAttributes { Order = 1 }));
Config.AddSetting("X", "3", 3, new ConfigDescription("", null, new ConfigurationManagerAttributes { Order = 2 }));

Как сделать пользовательский редактор для моей настройки?

Если вы используете тип настройки, который не поддерживается ConfigurationManager, вы можете добавить для него действие выдвижного ящика. Действие будет выполняться внутри OnGUI, используйте GUILayout, чтобы нарисовать настройки, как показано в примере ниже.

Чтобы использовать пользовательский ящик настройки для индивидуальной настройки, используйте поле CustomDrawer в классе атрибутов. Смотрите выше для получения дополнительной информации о