Windrose Mod Settings

Windrose Mod Settings 需要模组作者主动向管理器注册他们的模组才能正常显示。因此，看不到其他模组的设置是正常现象。如果你需要其他模组与之集成，请联系这些模组的作者，请求他们添加支持。

Windrose Mod Settings requires mod authors to actively register their mod with the manager for it to display properly. So not seeing other mods' settings is expected behavior. If you need other mods to integrate with it, please contact those mod authors and ask them to add support.

说明：本描述为中英双语版本，中文内容位于英文内容下方。

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

Description

R5 Mod Settings adds a Mods tab to the Windrose settings screen for UE4SS mods.

Adds a Mods page to the native game settings menu.

Uses native Windrose settings widgets for toggles, sliders, dropdowns, and keybinds.

Supports per-mod descriptions in the right-side help panel.

Supports optional Nexus Mods buttons through nexus_id.

Includes R5ModSettingsExample, a small example mod showing how third-party mods can register and read settings.

Special Thanks

Special thanks to Voidex1 for providing feedback, help, and testing!

For Mod Authors

Your UE4SS mod can register settings by writing a Lua manifest here:

Windrose\R5\Binaries\Win64\ue4ss\Mods\R5ModSettings\registrations\YourModName.lua

The manifest should return a Lua table like this:

name = "YourModName",

display = "Your Mod Name",

version = "1. 0. 0",

nexus_id = "442",

settings = {

key = "Enabled",

title = "Enabled",

description = "Turns the mod feature on or off.",

type = "toggle",

default = true,

key = "Multiplier",

title = "Multiplier",

description = "Controls the strength of the feature.",

type = "slider",

default = 1. 0,

min = 0. 1,

max = 5. 0,

step = 0. 1,

key = "Mode",

title = "Mode",

description = "Selects the behavior mode.",

type = "dropdown",

default = "normal",

options = {

{ value = "normal", label = "Normal" },

{ value = "fast", label = "Fast" },

key = "OpenMenuKey",

title = "Open Menu Key",

description = "Key used by this mod.",

type = "keybind",

default = {

primary = "F8",

secondary = "None",

Supported setting types:

If nexus_id is present, R5 Mod Settings adds an Open Nexus Mods button for that mod.

nexus_id = "xxx"

https://www.nexusmods.com/windrose/mods/xxx

Reading Settings

R5 Mod Settings writes saved values here:

Windrose\R5\Binaries\Win64\ue4ss\Mods\R5ModSettings\saved\YourModName.lua

When a manifest is registered or loaded, missing saved values are automatically initialized from the default values in the manifest.

Existing user values are not overwritten.

Primitive values are also published to UE4SS shared variables:

R5ModSettings/YourModName/Enabled

R5ModSettings/YourModName/Multiplier

R5ModSettings/YourModName/Mode

R5ModSettings/YourModName/OpenMenuKey/primary

R5ModSettings/YourModName/OpenMenuKey/secondary

keybind values are saved as primary/secondary Unreal key name strings, such as F8, SpaceBar, LeftShift, LeftMouseButton, or ThumbMouseButton.

R5 Mod Settings uses native Windrose key binding widgets for display. Clicking a key cell opens the native key binding popup. If the new key has no conflict, it is saved immediately after the player presses it. If it conflicts with a native or mod keybind, the popup shows the conflict warning and asks the player to confirm. Right-clicking an assigned key cell clears that slot to None.

Recommended reading pattern for your mod: