SULFUR Config

In-game configuration editor for SULFUR BepInEx mods.

SULFUR Config adds a native Options menu page where compatible BepInEx .cfg settings can be viewed, edited, and applied without manually opening config files.

Features

• Native SULFUR Options menu integration
• Edit BepInEx config entries in game
• Supports bool, number, text, enum, and acceptable value list settings
• Marks settings that need a restart, apply live, or are dangerous; shows allowed ranges
• Filters for pending changes and for tagged settings; advanced and hidden settings can be shown on request
• Per-mod localization support through each mod's own lang/*.json
• 14-language localization support for my SULFUR mods' config pages
• Pending-change workflow: edit first, then press Apply to save

Installation

Install with a Thunderstore-compatible mod manager, or manually place the files under BepInEx/plugins/.

Requires:

• BepInEx
• SULFUR Native UI Lib

For Players

Open the game Options menu and select SULFUR Config. Every installed mod that has settings is listed with its name and ID. Open a mod to see its settings, grouped by section.

With a keyboard or gamepad, press Enter (or A) on the SULFUR Config category first to move into the page, then use the arrow keys. Enter opens or closes a mod, Left and Right move between the buttons of a button row.

Changing a setting

• Change a value: the setting is marked Pending. Nothing is written yet.
• Press Apply at the bottom right to write every pending change to the mods' .cfg files.
• Default (shown on settings that are not at their default) sets the default value back as a pending change. Press Apply to save it.
• Pending changes are kept while the game runs, also when you close the menu. They are lost when you quit the game without pressing Apply.
• A value that the setting cannot take (wrong format, outside the allowed range) is shown as an error and is not written. Fix it or press Default.

After Apply the footer reads, for example, Applied and saved: 3, Failed: 0, Invalid: 1.

• Applied and saved: written to the setting and to its .cfg file.
• Invalid: not written because the value is not allowed. It stays pending.
• Failed: the mod rejected the change or the file could not be saved. The reason is in BepInEx/LogOutput.log.

Whether a change works immediately, after returning to the main menu, or only after a restart depends on the mod. Settings the mod marks as Restart Required or Live Apply show that badge.

Searching

Type in the Filter box, then press Apply Filter. Typing alone does not filter. The search matches mod names, mod IDs, section names, setting names and descriptions, in English and in your language. Clear Filter shows everything again.

The switches

Two switches add settings that are left out by default:

• Advanced: settings the mod marks as advanced.
• Hidden: settings the mod marks as hidden or internal (debug options and similar). Change them only if you know what they do.

The other switches show only the matching settings:

• Pending: settings with an unsaved change.
• Restart: settings that need a restart.
• Live: settings that apply while you play.
• Dangerous: settings the mod marks as risky. There is no extra confirmation when you change them.
• Ryuka: only mods by Ryuka, the author of SULFUR Config.

Other buttons

• Refresh: scans the mods again, for settings a mod creates after the game has started.
• Collapse All: closes every open mod and section.

Text settings

Hotkeys, colors, flag lists and similar settings are edited as text in the same format as the .cfg file. Hotkeys use Unity key names, which are case sensitive, for example F8 or F8 + LeftControl.

A mod is missing

A mod is listed only if it has settings in its main BepInEx config. Some mods create their settings later; press Refresh. Check also that the Filter box is empty and that no switch is on.

Localization Status

All of my current SULFUR mods include localization files for SULFUR Config's in-game settings page.

This localization support is for the config UI only. It localizes mod names, config sections, setting names, setting descriptions, and supported enum/list values shown inside SULFUR Config. It does not change the game's own text, item names, dialogue, or gameplay content.

Supported languages:

• English
• Simplified Chinese
• Swedish
• French
• Italian
• German
• Spanish
• Portuguese
• Russian
• Polish
• Japanese
• Korean
• Turkish
• Arabic

These localizations have not been fully tested in every language yet. Some translations may be incomplete, awkward, or need later correction.

For Mod Developers

SULFUR Config automatically reads standard BepInEx ConfigEntry values.

For best display quality, third-party mod developers should provide clear ConfigDescription, reasonable AcceptableValueRange / AcceptableValueList, optional tags such as LiveApply or RestartRequired, and per-mod localization files.

The adapter guide (tags, localization files, how each setting type is shown) is in the docs folder of the GitHub repository:

https://github.com/ryuka-dev/SULFUR-Config-mod

Source Code

Source code is available on GitHub:

https://github.com/ryuka-dev/SULFUR-Config-mod

The repository contains my original mod source code and documentation. It does not include SULFUR game files, Unity assemblies, BepInEx binaries, paid assets, or decompiled game source.

Feedback

Please report bugs, compatibility issues, localization issues, or adapter documentation problems on GitHub.