mw-god-mod

v36.1.5

Published

4 months ago

GodMod Credit By G.S.C.

Downloads

0High
0Medium
0Low

lviatyi

module back-stage mw

God Mod

无所不能...... 在下一个轮回.

God Mod 是新一代管理命令工具. 允许在游戏中调用任何管理命令。

God Mod 依赖 Lynx UI 提供的自生成 UI 能力，其不需要借助任何 .ui 即可享受高复用性的 UI 组件化能力。

v36.1.5
by LviatYi
by ZeWei.Zhang
thanks Lei.Zhao 前辈提供的灵感来源

阅读该文档时，推荐安装以下字体：

若出现乱码，其为 Nerd Font 的特殊字符，不影响段落语义。

Functional ⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠐⠒⠒⠒⠒⠚⠛⣿⡟⠄⠄⢠⠄⠄⠄⡄⠄⠄⣠⡶⠶⣶⠶⠶⠂⣠⣶⣶⠂⠄⣸⡿⠄⠄⢀⣿⠇⠄⣰⡿⣠⡾⠋⠄⣼⡟⠄⣠⡾⠋⣾⠏⠄⢰⣿⠁⠄⠄⣾⡏⠄⠠⠿⠿⠋⠠⠶⠶⠿⠶⠾⠋⠄⠽⠟⠄⠄⠄⠃⠄⠄⣼⣿⣤⡤⠤⠤⠤⠤⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄

它旨在提供如下便利：

[x] 呼风唤雨 模糊搜索与拼音搜索随心所欲地触及.
[x] 一板一眼 简单类型与 Mw 常用类型参数验证、Enum 自动转下拉列表与配置表参数快速预览.
[x] 上炕揭瓦 尽可能贴近现存的 Api 设计，提供快捷的替换步骤.
[x] 前辙可鉴 提供命令与参数的历史记录快速重复命令.
[x] 召之即来 提供常用的一般性命令.
[x] 呼之即去 允许最小化或关闭，不做屏幕霸占者.
[x] 交互艺术 允许拖动显隐窗口.
[x] 触手可得 自生成 UI. 不依赖任何其他要素.
[x] 一夫当关 强弱权限认证. KV 存储的用户权限凭证.
[x] 已读立回 完善的交互反馈. 提供运行结果的单层反馈.
[x] 随机应变 允许在启动 UI 页后继续追加 GM 命令.
[ ] 记忆金属 对使用痕迹进行保存从中分析优化流程的信息.

Deficiency ⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠐⠒⠒⠒⠒⠚⠛⣿⡟⠄⠄⢠⠄⠄⠄⡄⠄⠄⣠⡶⠶⣶⠶⠶⠂⣠⣶⣶⠂⠄⣸⡿⠄⠄⢀⣿⠇⠄⣰⡿⣠⡾⠋⠄⣼⡟⠄⣠⡾⠋⣾⠏⠄⢰⣿⠁⠄⠄⣾⡏⠄⠠⠿⠿⠋⠠⠶⠶⠿⠶⠾⠋⠄⠽⠟⠄⠄⠄⠃⠄⠄⣼⣿⣤⡤⠤⠤⠤⠤⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄

然而它亦面临无法避免的难题：

初出茅庐 GodMod 目前处于新硎初试的状态。

Outlook ⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠐⠒⠒⠒⠒⠚⠛⣿⡟⠄⠄⢠⠄⠄⠄⡄⠄⠄⣠⡶⠶⣶⠶⠶⠂⣠⣶⣶⠂⠄⣸⡿⠄⠄⢀⣿⠇⠄⣰⡿⣠⡾⠋⠄⣼⡟⠄⣠⡾⠋⣾⠏⠄⢰⣿⠁⠄⠄⣾⡏⠄⠠⠿⠿⠋⠠⠶⠶⠿⠶⠾⠋⠄⠽⠟⠄⠄⠄⠃⠄⠄⣼⣿⣤⡤⠤⠤⠤⠤⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄

可见的预期中，它将实现以下目标：

在 LviatYi 将自研的 i18n 打包后，接入该 i18n 工具，以对 GameConfig 的预览进行可能的本地化。
展开式的命令选择方式。
提供一种尺寸调整的交互方式。

同时它也欢迎有志者的贡献：

提出一个 Issue 或 Pull Request，或者直接联系 LviatYi。

Example ⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠐⠒⠒⠒⠒⠚⠛⣿⡟⠄⠄⢠⠄⠄⠄⡄⠄⠄⣠⡶⠶⣶⠶⠶⠂⣠⣶⣶⠂⠄⣸⡿⠄⠄⢀⣿⠇⠄⣰⡿⣠⡾⠋⠄⣼⡟⠄⣠⡾⠋⣾⠏⠄⢰⣿⠁⠄⠄⣾⡏⠄⠠⠿⠿⠋⠠⠶⠶⠿⠶⠾⠋⠄⠽⠟⠄⠄⠄⠃⠄⠄⣼⣿⣤⡤⠤⠤⠤⠤⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄⠄

以下是一个面向程序配置的简单示例：

快速升级

从旧有的代码中升级：

// <<<<<<< ORIGIN
AddGMCommand(
    "CommandLabel",
    (player, param) => console.log("Client CMD", player.playerId),
    (player, param) => console.log("Server CMD"),
    "CommandGroup",
);
// =======
addGMCommand(
    "CommandLabel",
    "string", // 直接对应替换为 string，但推荐使用更为精确的类型
    (param) => console.log("Client CMD", mw.Player.localPlayer.playerId),
    (player, param) => console.log("Server CMD"),
    undefined,  // 参数选项 可进一步描述参数 label 或数据验证
    "CommandGroup",
);
// >>>>>>> UPGRADE TO

初始化

GodMod 作为命令管理后台，它提供了由 C 端直接引发 S 端变化的通道，需要程序谨慎使用。什么是「仅服务端函数不扩散条约 (SONPT)」
因此 GodMod 默认不显示在游戏内，需要进行一些初始化步骤。

if (GameServiceConfig.isRelease) {
    // 正式发布.
    GodModService.getInstance()
        .setAuthStrategy("strong");
}

GodModService.getInstance()
    .addPreviewForGameConfig(GameConfig) // 对所有配置开启预览功能.
    .authShowGm(); // 带验证的显示.

GodMod 提供两种策略对用户进行认证：

strong 强认证 用户的 UserId 必须在 KV 存储的管理员名单中存在，才能正常使用 GodMod。
weak 弱认证 如果为 PIE 环境，或未配置管理员名单，用户可以直接使用 GodMod。

管理员名单存储于 KV，可以通过 Web 后台进行添加。

Key 为 GOD_MOD_ADMIN_LIST__STORAGE_KEY

添加指令

GodMod 提供了全栈的类型提示、完备的参数验证。程序需要更多地承担一些义务，来告知策划应该提供什么类型的参数。

虽然看似提高了程序的成本，但相信我，GodMod 内部复杂的类型体操与基于 Lui 的组件化参数输入窗口将成倍地提高所有项目开发者的收益。

下方提供一些示例：

添加一个无参指令

addGMCommand("say", "void", () => {
    Log4Ts.log(testGmPanel, `say something`);
});

添加一个 Vector 类型指令

addGMCommand("vector", "vector", (params) => Log4Ts.log(testGmPanel, `value: ${params}`));

程序可以惊喜的发现，params 是 Vector 类型，而非一个简单的 string。同时，使用者将遇到一个这样的输入框：

添加一个带参数验证的 Integer 类型指令

addGMCommand(
    "range",
    "integer",
    (params) => Log4Ts.log(testGmPanel, `value: ${params}`),
    undefined,
    {
        validator: [(param) => param >= 0 && param <= 10],
    },
    "Validator"
);

validator 是一个数组，可以添加多个验证函数。
当输入框失去焦点时，将会依次调用这些函数，如果有一个函数返回 false ，则会提示用户输入不合法。
validator 的元素为一个 (DataValidator) 谓词，或是一个归因 󰌆 数据验证器 (DataValidatorWithReason) ，后者在验证失败时，会提示用户输入不合法的原因。
"Validator" 指明该命令属于 Validator 组。

addGMCommand(
    "range",
    "integer",
    (params) => Log4Ts.log(testGmPanel, `value: ${params}`),
    undefined,
    {
        validator: [RangeDataValidator(0, 10)],
    },
    "Validator"
);

也可以使用 RangeDataValidator ，它是内置的参数验证生成器中的一个，它能够快速提供一个可归因的范围验证。

添加一个 Enum 类型指令

enum DynamicEnum {
    A,
    B,
    C,
}

addGMCommand(
    "enum A",
    DynamicEnum,
    (params) => {
        switch (params) {
            case DynamicEnum.A:
                Log4Ts.log(testGmPanel, `StateA`);
                break;
            case DynamicEnum.B:
                Log4Ts.log(testGmPanel, `StateB`);
                break;
            case DynamicEnum.C:
                Log4Ts.log(testGmPanel, `StateC`);
                break;
        }
        Log4Ts.log(testGmPanel, `value: ${params}`);
    },
    undefined,
    undefined,
    "Enum"
);

同样地，params 是 DynamicEnum 类型。
由于 LviatYi 为程序付出了诸多关于类型推断的努力，任何动态的 Enum 类型都是允许的。
Enum 不需要参数验证。因为使用者将使用 Lui 的 AutoComplete 控件，选择一个编译阶段前定义好的 Enum 值。

添加一个 GameConfig 类型指令

addGMCommand(
    "use DialogueContentNode Config",
    GameConfig.DialogueContentNode,
    (params) => {
        Log4Ts.log(testGmPanel, `id: ${params.id}`, `content: ${params.content}`);
    },
    undefined,
    undefined,
    "Config"
);

GameConfig 是由 @ZeBin.Ge 定义的静态数据配置规范。
GodMod 将自动捕获 id name 等字段，并提供预览能力。

params 是 IDialogueContentNodeElement 类型。
使用者输入对应配置的 ConfigId。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme