TRSS-Yunzai QQBot Plugin

TRSS-Yunzai QQBot 适配器 插件

Tip

建议使用TRSS原版,此版本为小叶Fork个人自用版的修改版,会在任意时间直接进行更改,且不会与TRSS一致
可使用自定义ws连接其他人搭建的webhook-to-websocket服务，从而实现无缝切换webhook
班级群： 1057604000

自己部署webhook转发服务

• Python后端（Linux推荐）：qbot-webhook-to-websocket
• Node.js后端（Windows推荐-TS霆生のwebhook转发服务同款👍）：Node.js-qbot-webhook-to-websocket（Gitee） | Node.js-qbot-webhook-to-websocket（Github）

使用TS霆生のwebhook转发服务（免费）

1. QQ机器人后台回调配置链接：https://bot.191800.xyz/webhook?secret={secret}，{secret}替换为bot secret
2. 插件ws连接配置：ws://bot.191800.xyz/ws/{secret}，{secret}替换为bot secret

自用Fork版

0. 自定义ws接收地址，在config/QQBot.yaml中添加以下配置项，BotQQ改为机器人QQ号

   WsUrl:
     BotQQ: ws://...
     BotQQ: ws://...

1. 转发消息改为渲染成图片,需要安装ws-plugin
2. #QQBot设置转换开启配合#ws绑定实现互通数据
3. #QQBotDAU and #QQBotDAUpro
4. Model/template/groupIncreaseMsg_default.js中自定义入群发送主动消息
5. config/QQBot.yaml中使用以下自定义模版,如果设置了全局md会优先使用自定义模版,配合e.toQQBotMD = true将特定消息转换成md,亦可在全局md模式下通过e.toQQBotMD = false将特定消息不转换成md
   • 方法1: 直接修改config/QQBot.yaml (推荐)

     customMD:
       BotQQ:
         custom_template_id: 模版id
         keys:
           - key1 # 对应的模版key名字
           - key2
           # ... 最多10个

   • 方法2: 在Model/template目录下新建markdownTemplate.js文件,写入以下内容 (不推荐)

     // params为数组,每一项为{key:string,values: ['\u200B']} // values固定为['\u200B']
     export defalut {
       custom_template_id: '',
       params: []
     }

6. #QQBot调用统计 根据e.reply()发送的消息进行统计,每条消息仅统计一次,未做持久化处理,默认关闭,#QQBot设置调用统计开启
7. config/QQBot.yaml中使用以下配置项,在全局MD时会以MD的模式自动加入params中

   mdSuffix:
     BotQQ:
       - key: key1
         values:
           - value # 如果用到了key则不会添加
       - key: key2
         values:
           # \ 需转义 \\
           - "{{ e.msg.replace(/^#/g, '\\/') }}" # {{}}中为动态参数,会在发送时替换成对应值,目前仅有e可用,也可以传入js表达式等等, 后续可能会添加自定义方法
       # ...

8. config/QQBot.yaml中使用以下配置项,在全局MD时会以button的模式自动加入按钮指定行数并独占一行,当超过5排按钮时不会添加

   btnSuffix:
     BotQQ:
       position: 1 # 位置:第几行 1 - 5
       values:
         - text: test
           callback: test
           show: # 达成什么条件才会显示
             type: random # 目前仅支持 random
             data: 50 # 0-100
         - text: test2
           input: test2
         # ... 最多10个

9. #QQBot用户统计: 对比昨日的用户数据,默认关闭,#QQBot设置用户统计开启
10. config/QQBot.yaml中使用前台日志消息过滤（自欺欺人大法），将会不在前台打印自定的消息内容，防log刷屏（比如修仙、宝可梦等），也可以使用#QQBot添加/删除过滤日志垃圾机器人
    • 自定义消息采取完整消息匹配，非关键词匹配
    • 非必要不建议开启此项

      注意：只会过滤部分QQBot的日志

    filterLog:
      BotQQ:
        - 垃圾机器人
        - 垃圾bot
        - 垃圾Bot
        # ...

11. config/QQBot.yaml中simplifiedSdkLog是否简化sdk日志,若设置为true则不会打印 recv from Group(xxx): xxx,并且会简化发送为send to Group(xxx): <markdown><button>
12. #QQBot一键群发: 需要先配置模版 template/oneKeySendGroupMsg_default.js
13. config/QQBot.yaml中markdownImgScale: 1是否对markdown中的图片进行等比例缩放,0.5为缩小50%,1.5为放大50%,以此类推
14. config/QQBot.yaml中sendButton: true未开启全局MD时是否单独发送按钮

安装教程

1. 准备：TRSS-Yunzai
2. 在云崽根目录/plugins 下打开终端运行命令：Git clone + 此仓库链接
3. 打开QQBot-Plugin，执行依赖安装命令：pnpm i

默认使用qq-official-bot@1.0.3版本，如需使用qq-official-bot@1.0.12版本，则再执行pnpm i qq-official-bot@1.0.12

4. 打开：QQ 开放平台 创建 Bot：
   ① 创建机器人
   ② 开发设置 → 得到 机器人QQ号:AppID:Token:AppSecret
5. 输入：#QQBot设置机器人QQ号:AppID:Token:AppSecret:[01]:[01]

Token已全面弃用，随便填一个进去就行了

格式示例

• 机器人QQ号 114 AppID 514 Token 1919 AppSecret 810 群Bot 频道私域

#QQBot设置114:514:1919:810:1:1

#QQBot登录114514:1:1

• WebHook

#QQBot设置114:514:1919:810:2

#QQBot登录114514:2

需要启用公网 HTTPS，开放平台添加 {url}/QQBot

发送图片（二选一）

• MD消息模式：使用内置图床发送图片
• 切换普通消息，输入 #QQBotMD机器人QQ号:legacy

使用教程

• #QQBot账号
• #QQBot登录 + 机器人QQ号:是否群Bot:是否频道私域（是1 否0）（扫码授权的方式会重置密钥，请注意保存新的密钥）
• #QQBot设置 + 机器人QQ号:AppID:Token:AppSecret:是否群Bot:是否频道私域（是1 否0）
• #QQBotMD + 机器人QQ号:模板ID
• #QQBotMD + 机器人QQ号:raw/legacy（MD消息/普通消息）
• #QQBot设置文字链 + 开启/关闭（是否开启按钮转文字链）