原生模组设置

创作者: NckDotCom

已更新:2026-10-10 01:39:26

0KB

关于此 MOD

在游戏界面中添加一个原生模组设置标签页。

描述
添加一个模组切换到主菜单和单人游戏暂停菜单的“设置”页面。支持的模组通过带注释的 INI 文件提供各自的滑块和开关。

选择 确认更改 保存。更改是立即生效、加载世界后生效还是重启后生效，取决于模组。建筑限制扩展支持实时更改。之前的INI文件已备份。

安装说明
清理完成后关闭 Dune 和 WPS。将 ZIP 解压到你的 WPS 启动器文件夹，启用 Mod 设置和 WPS 框架，然后通过 WPS 启动。

要求
单人游戏，Steam 版本 25486029，WPS 启动器和 WPS 框架。

添加到你的模组：
把mod.ini放到mod.json旁边。只有带注释的键才会显示在游戏菜单中。

我的模组
; @label 这个模组有多好？
；@description 是个好模组！
；@类型 整数
; @min 1
; @max 5
； @步骤 1
；@default 1
; @菜单 主菜单， 游戏中
； @apply live
模组良好=1

；@label 已启用
；@type boolean
; @菜单 主菜单
已启用=true

注释属于下一个键。每行注释只能有一条注解；接受“;”和“#”。保存时，当前菜单中隐藏的现有注释、未注解的键和值将被保留。

所有 @type 值

数值	控制	INI值
整数	整数滑块	8
数字	允许小数的滑块	0.25
布尔值	关 / 开开关	真 / 假，或 0 / 1

字符串、下拉菜单及其他类型暂不支持。

所有@menu值

价值	出现于
主菜单	主菜单设置
游戏内	单人游戏暂停菜单设置
主菜单，游戏内	两者（省略时的默认值）

游戏内的反转列表，主列表也可用。名称区分大小写。仅控制可见性。
其他注释

注解	接受值 / 默认值
@标签	显示名称；否则从键派生
@description	一行帮助文本；否则为空
@min、@max	数值类型必填；最大值必须大于最小值
@step	正值增量；默认为1
默认	匹配该类型的有效值；否则使用初始INI值
应用	实时、重载或重启；默认重启

live 表示模组立即应用更改；

重新加载意味着在世界加载时；

重启将在下次启动游戏时生效。
这只是回调的元数据。模组必须实现所选择的行为。

@default 是元数据；保存时不会重置值或插入缺失的键。

数值最多支持三位小数，范围为-1,000,000到1,000,000。步长至少为0.001；范围最多支持1,000,000步。最大值和当前值都必须位于从最小值开始按步长测量的位置上。整数范围和步长必须为整数。

注册并处理存档
这用完了我的建筑限制扩展以该模组为例，你可以下载它并自行查看集成方式。

使用你现有的WPS框架应用。只需从Scripts/main.lua注册一次（Scripts文件夹内直接放置的另一个Lua文件也可以）：

API 会等待游戏线程和 WPS 就绪后，再对外公布你的设置。

本地设置 = require('../../模组设置/脚本/api')
设置.register(app, debug.getinfo(1, 'S').source, {
    onSave = function(values, changed, context)
        如果 context.menu == 'ingame' 且 changed.BuildingLimits 则
            应用建筑限制(values.BuildingLimits)
        结束
    结束，
})

applyBuildingLimits 代表你的模组的更新函数。将 BuildingLimits 和 applyBuildingLimits 替换为你模组的 INI 节和更新函数。

扩展建筑限制的Scripts/main.lua
包含一个可用的集成。你的模组还应在启动或加载世界时读取其INI文件。

values[section][key]：所有已标注的值，为 Lua 数字或布尔值。
changed[section][key]：仅包含自注册或上次成功回调以来发生变更的值。changed 布尔值可能为 false；测试单个键时请使用 ~= nil 进行判断。
主菜单或游戏内菜单。
context.apply[section][key]：已更改键的 @apply 值。

回调在游戏线程中运行，处于你的模组的 Lua 上下文中，在 INI 保存后执行。成功时正常返回；返回 false、"reason" 或抛出错误以报告失败。回调失败会保留已保存的 INI 并报告错误。请在你自己的回调中安全地验证并应用运行时更改。

如果你的模组只在启动时读取设置，则可以省略 onSave。

使用 file = 'settings.ini' 可在你的模组文件夹中选择另一个 INI 文件名。注册至少需要一个带注释的键、一份有效的 WPS 清单，以及一个仅包含字母、数字、下划线或连字符的文件夹名称。

若需可选集成，请使用 pcall(require, '../../ModSettings/Scripts/api') 加载 API，并仅在可用时进行注册。否则请将 Mod Settings 声明为必需依赖。不要将其 API 复制到你的模组中。

本页面自动发现已注册且正在运行的WPS模组。未注册或已禁用的模组不会列出。INI文件限制为64 KB，每个模组最多128个带注释的键。冲突的外部编辑将被拒绝；请重新打开设置以读取它们。每个模组的INI单独保存，并附带备份。

大声喊
游戏内容归Funcom及其授权方所有。感谢WPS Dune Framework和UE4SS。