上一主题 下一主题
ScriptCat,新一代的脚本管理器脚本站,与全世界分享你的用户脚本油猴脚本开发指南教程目录
返回列表 发新帖

[脚本猫开发指南]用户配置

[复制链接]
  • TA的每日心情
    开心
    6 小时前
  • 签到天数: 213 天

    [LV.7]常住居民III

    305

    主题

    4189

    回帖

    4056

    积分

    管理员

    积分
    4056

    管理员荣誉开发者油中2周年生态建设者喜迎中秋油中3周年挑战者 lv2

    发表于 2021-9-14 16:46:58 | 显示全部楼层 | 阅读模式

    官方文档:用户配置

    配置声明

    为了方便用户配置,脚本猫提供了一个==UserConfig==的注释,使用YAML来进行声明 YAML 语言教程

    在脚本代码中,使用==UserConfig==来包裹住yaml配置内容

    /* ==UserConfig==
    配置内容
     ==/UserConfig== */

    暂时支持如下几种配置:文本、密码、选择框、列表框、数字,主要根据default的声明来进行识别,并且支持配置组,以顶层key为组名称,支持中文,在编写的时候需要注意空格间距,多个配置组之间使用 --- 进行分隔,如果不进行分隔,在未来的更新中可能会出现问题(如果有i18n的计划,可能会使用顶层key来声明i18n)

    /* ==UserConfig==
    group1:
      configA:                                # 键值为group.config,例如本键为:group1.configA
        title: 配置A                          # 配置的标题
        description: 这是一个文本类型的配置     # 配置的描述内容
        default: 默认值                       # 配置的默认值
        min: 2                                # 文本最短2个字符
        max: 18                               # 文本最长18个字符
        password: true                        # 设置为密码
      configB:
        title: 配置B
        description: 这是一个选择框的配置
        default: true
      configC:
        title: 配置C
        description: 这是一个列表选择的配置
        default: 1
        values: [1,2,3,4,5]
      configD:
        title: 配置D
        description: 这是一个数字的配置
        default: 1
        min: 10  # 最小值
        max: 16  # 最大值
        unit: 分 # 表示单位
    ---
    group2:
      configX:
        title: 配置A
        description: 这是一个文本类型的配置
        default: 默认值
     ==/UserConfig== */

    读取配置

    定义完成后,会在控制面板中显示配置按钮,供用户配置,开发者使用GM_getValue获取配置的值,key使用group.config来表示。

    因为使用的是Value的原因,可以使用@storageName来共享多个脚本之间的配置,并且配置的修改是实时更新的。

    上不慕古,下不肖俗。为疏为懒,不敢为狂。为拙为愚,不敢为恶。
  • TA的每日心情
    开心
    2022-7-5 00:02
  • 签到天数: 124 天

    [LV.7]常住居民III

    5

    主题

    168

    回帖

    927

    积分

    版主

    积分
    927

    荣誉开发者油中2周年

    发表于 2021-9-14 18:00:11 | 显示全部楼层
    好,学着搞
    回复

    使用道具 举报

  • TA的每日心情
    无聊
    2022-9-24 23:46
  • 签到天数: 1 天

    [LV.1]初来乍到

    1

    主题

    13

    回帖

    16

    积分

    助理工程师

    积分
    16
    发表于 2022-9-14 11:11:04 | 显示全部楼层

    这个界面能加个显示用户配置的按钮,否则一般用户用起来太麻烦了。先点主页,再找到那个小小的设置按钮,我昨晚看了一圈,都没看到那个设置按钮。😤

    QQ截图20220914110628.png

    回复

    使用道具 举报

  • TA的每日心情
    开心
    6 小时前
  • 签到天数: 213 天

    [LV.7]常住居民III

    305

    主题

    4189

    回帖

    4056

    积分

    管理员

    积分
    4056

    管理员荣誉开发者油中2周年生态建设者喜迎中秋油中3周年挑战者 lv2

    发表于 2022-9-14 11:35:24 | 显示全部楼层
    大白兔奶糖 发表于 2022-9-14 11:11
    [md]这个界面能加个显示用户配置的按钮,否则一般用户用起来太麻烦了。先点主页,再找到那个小小的设置按钮 ...

    安排!是一个好建议
    上不慕古,下不肖俗。为疏为懒,不敢为狂。为拙为愚,不敢为恶。
    回复

    使用道具 举报

    该用户从未签到

    3

    主题

    11

    回帖

    21

    积分

    助理工程师

    积分
    21
    发表于 2023-8-15 22:59:33 | 显示全部楼层
    可以不分组吗,还是必须写至少一个group
    回复

    使用道具 举报

    该用户从未签到

    3

    主题

    11

    回帖

    21

    积分

    助理工程师

    积分
    21
    发表于 2023-8-15 23:10:02 | 显示全部楼层
    square_http 发表于 2023-8-15 22:59
    可以不分组吗,还是必须写至少一个group

    好吧,必须分组,不分组设置界面就成了一堆怪东西.
    回复

    使用道具 举报

  • TA的每日心情
    开心
    6 小时前
  • 签到天数: 213 天

    [LV.7]常住居民III

    305

    主题

    4189

    回帖

    4056

    积分

    管理员

    积分
    4056

    管理员荣誉开发者油中2周年生态建设者喜迎中秋油中3周年挑战者 lv2

    发表于 2023-8-15 23:27:01 | 显示全部楼层
    square_http 发表于 2023-8-15 23:10
    好吧,必须分组,不分组设置界面就成了一堆怪东西.

    必须分组的
    上不慕古,下不肖俗。为疏为懒,不敢为狂。为拙为愚,不敢为恶。
    回复

    使用道具 举报

    发表回复

    本版积分规则

    快速回复 返回顶部 返回列表