Skip to content

指令映射 ​

你可以将一个规则映射成指令,这样更方便测试。

在配置文件中具体做法如下:

yaml
bot:
  commands: # bot的指令设置
    - name: "ping" # 指令名称
      enable: true # 是否启用该指令,默认 true。未启用时,无法使用该指令。
      rule: "ping" # 对应的规则名,会读取你配置好的规则,读取不到则判定该指令为普通指令,而非测试指令。普通指令相当于 /help /version 这些,等于仅修改描述文本,而无实际测试功能
      pin: true # 是否固定指令,固定指令后会始终显示在 TG 客户端的指令列表中,默认 false。
      text: "" # 指令的提示文本,默认空时自动使用name的值
      attachToInvite: true # 附加到 invite 指令中选择的按钮

设置好后,就可以这样发起测试:

/ping <订阅地址>

特性 ​

  • 享受所有测试指令的指令参数支持,也享受过滤器支持。
  • /re 指令仍然生效。

关于 attachToInvite ​

attachToInvite 决定这条映射出来的指令是否出现在 /invite 的测试项按钮中:

  • 设为 true 时,被邀请方可以选择这条指令对应的规则进行测试
  • 设为 false 时,该选项不会出现在 invite 的按钮里

对于内置测试指令(test、analyze、topo、speed、uspeed),同样可以通过为同名指令设置 attachToInvite: false 来移除 invite 中的内置按钮,按钮文案取自该指令的 text 字段。

说明

对内置测试指令的移除效果从 v2.1.0 起被支持。

文档内容同步自 koipy-public