Millennium Steam Patcher 插件设置菜单功能解析

背景介绍

Millennium Steam Patcher 是一个用于 Steam 客户端的主题修改工具，它允许用户通过插件和主题来定制 Steam 界面。在最新开发中，项目团队为插件系统增加了设置菜单功能，这为插件开发者提供了更灵活的配置选项。

功能设计

新功能的设计灵感来源于 Celeste 模组系统的设置实现方式，采用了 TypeScript 装饰器来简化设置项的声明和管理。这种设计模式具有以下优势：

1. 声明式编程：通过装饰器语法，开发者可以直观地定义设置项
2. 类型安全：利用 TypeScript 的类型系统确保设置项的类型正确性
3. 可扩展性：支持多种设置类型，包括滑块、文本输入、开关等

技术实现

核心类型定义

系统首先定义了设置项的基本类型枚举和数据结构：

enum SettingType {
    Unknown,
    NumberInput,
    TextInput,
    Dropdown,
    Toggle,
    Slider,
    Color,
}

type SettingOptions = {
    name: string;
}

type SliderOptions = SettingOptions & {
    min: number;
    max: number;
}

type Setting = {
    type: SettingType;
    options: SettingOptions | SliderOptions;
}

interface SettingsData {
    settings: { [key: string]: Setting };
}

装饰器实现

系统提供了两个核心装饰器：

1. DefineSetting：用于定义基本设置项
2. SettingRange：用于为数值型设置项指定范围

function DefineSetting<T>(options: {name: string}, type: T) {
    return function (target: SettingsData, propertyKey: string) {
        if (!target.settings) {
            target.settings = {};
        }
        target.settings[propertyKey] = {
            type: resolveSettingType(type),
            options: {...options},
        };
    };
}

function SettingRange(options: { min: number, max: number }) {
    return function (target: SettingsData, propertyKey: string) {
        const setting = target.settings[propertyKey];
        setting.options = {...setting.options, ...options};
    };
}

使用示例

开发者可以这样定义自己的插件设置：

class ExampleSettingsData implements SettingsData {
    settings: { [key: string]: Setting; };

    @SettingRange({ min: 0, max: 100 })
    @DefineSetting({ name: "音量大小" }, Number)
    public volume: number = 50;

    @DefineSetting({ name: "用户名" }, String)
    public username: string = "";
}

功能特点

1. 多种设置类型支持：系统自动识别并支持数字、字符串、布尔值等基本类型
2. 范围限制：可为数值型设置指定最小/最大值
3. 默认值支持：直接在类属性中指定默认值
4. 类型推断：根据属性类型自动推断合适的UI控件

开发建议

1. 确保在 tsconfig.json 中启用装饰器支持："experimentalDecorators": true
2. 对于复杂设置项，可以扩展新的装饰器来支持更多配置选项
3. 考虑将设置数据持久化存储，确保用户配置在重启后仍然有效

总结

Millennium Steam Patcher 的插件设置菜单功能为插件开发者提供了强大而灵活的工具，使得插件配置更加直观和易于管理。通过装饰器模式，开发者可以专注于业务逻辑，而无需过多关注设置项的UI实现细节。这一功能的加入将大大提升插件的可配置性和用户体验。