ApliNi
  1. ## Chat2QQ+

  3. > **说明**

  5. Chat2QQ+ 是 [Chat2QQ](https://github.com/DreamVoid/Chat2QQ) 的分支, 用于添加我需要的功能.

  7. 如果你有好的想法请点击上方 `Issues` 按钮, 发送一个功能请求. 如果我能做到就会去实现出来.

  9. ! 注意, 此版本不兼容 Bukkit 服务器, 最低需要使用 1.18.2 版本的 Spigot (Chat2QQ-1.7.4 及以下版本支持 MC1.13.2).



  13. > **下载**

  15. 可以点击右侧 `Releases` 按钮下载jar文件. 对于新添加的功能请在这里提问(而不是 DreamVoid/Chat2QQ).

  17. 如果需要开发版(包含一些未发布的功能和BUG), 可以点击上方 `Actions`, 选择第一个, 找到最下面的jar文件.



  21. > **订阅更新**

  23. 如果想要订阅更新, 请点击右上角 `Watch` 按钮, 选择 `Custom` 中的 `Releases` !

  25. ---

  27. **功能列表**

  29. - 执行指令
  30. ```yaml
  31.   # 在QQ群中运行指令 [需要单独添加 QQ群]
  32.   # 此模块不处理黑名单 blacklist
  33.   run-command:
  34.     enabled: false
  35.     # 启用的 QQ群
  36.     qq-group:
  37.       - 1000001

  39.     # 指令前缀, 可以是多个字符, 比如 "~$"
  40.     command-prefix: '/'
  41.     # 指令最大长度 (不包括指令前缀)
  42.     command-max-length: 255
  43.     # 获取指令的正则表达式, 当第一个捕获组的内容与指令白名单中的匹配时则允许运行 (不带斜杠或前缀)
  44.     regex-command-main: '^([^ ]+)'

  46.     # 是否发送指令的输出, 关闭可提高性能或解决一些兼容性问题
  47.     return: true
  48.     # 等待指令运行多长时间再将结果发送到QQ群 (毫秒), 需要开启 run-command.return
  49.     return-sleep: 300
  50.     # 是否将指令的输出打印到控制台和日志
  51.     return-log: true

  53.     # 执行不在白名单中的指令时发送返回消息
  54.     message-miss: '未命中的指令'
  55.     # 运行无返回指令的消息
  56.     message-no-out: '运行无返回指令'

  58.     # 设置各组可执行的主命令白名单 (不带斜杠或前缀)
  59.     # 权限更高的用户将可以使用更低的用户的指令
  60.     # 如果添加一条 ___ALL_COMMAND___ 作为指令, 则表示此组可以使用所有指令, 此功能请勿随意使用 !
  61.     group:
  62.       # permission_<int> 是 MiraiMC 获取到的权限数字, 以后更新了其他权限只需要以此格式添加即可使用
  63.       permission_2: # 群主
  64.       #- chat2qq
  65.       permission_1: # 管理员
  66.       #- spark
  67.       permission_0: # 成员
  68.       #- list
  69.       #- tps
  70. ```

  72. - 匹配游戏名
  73. ```yaml
  74.   # 从 群名片(%nick%) 中匹配 MC 可用的游戏名称
  75.   # 添加变量: %regex_nick% - 使用正则匹配到的名称, 需要开启 cleanup-name 功能
  76.   cleanup-name:
  77.     enabled: false
  78.     # 程序取第一个捕获组的结果
  79.     regex: '([a-zA-Z0-9_]{3,16})'
  80.     # 如果匹配不到, 则使用 %nick%, 也可以替换为其他 %regex_nick% 以外的变量或字符串
  81.     not-captured: '%nick%'
  82. ```

  84. - 消息预处理
  85. ```yaml
  86.   # 预处理 %message% 中的消息
  87.   pretreatment:
  88.     enabled: true
  89.     # **使用方法**
  90.     # list:
  91.     #   - 匹配方式: prefix (前缀匹配), 可用处理方式: to_all
  92.     #                                           to_replace
  93.     #             contain (包含), 可用处理方式: to_all
  94.     #                                        to_replace
  95.     #             equal (完全相等), 可用处理方式: to_all
  96.     #             regular (正则匹配), 可用处理方式: to_all
  97.     #                                           to_regular
  98.     #     处理方式: to_all (替换整条消息)
  99.     #             to_replace (替换匹配到的部分)
  100.     #             to_regular (使用正则替换, 可使用正则变量)
  101.     #
  102.     #     是否发送: send (填写 send 配置将取消转发送匹配到的消息, 不需要时请忽略)
  103.     #
  104.     # > 正则的性能较差, 请尽量避免使用很多正则
  105.     # 示例配置, 默认配置了一些可能有用的功能:
  106.     list:

  108.       # 卡片消息, JSON
  109.       - prefix: '{"app":"com.tencent.'
  110.         to_all: '[卡片消息]'

  112.       # 群公告, JSON
  113.       - prefix: '{"app":"com.tencent.mannounce"'
  114.         to_all: '[群公告]'

  116.       # 视频, 字符串
  117.       - prefix: '你的QQ暂不支持查看视频短片'
  118.         to_all: '[视频]'

  120.       # 文件, 字符串, 调整格式
  121.       - prefix: '[文件]'
  122.         to_replace: '[文件] '

  124.       # 解决 Emoji 显示为未知字符
  125.       - regular: '[\ud83c\udc00-\ud83c\udfff]|[\ud83d\udc00-\ud83d\udfff]|[\u2600-\u27ff]'
  126.         to_regular: '[Emoji]'
  127. ```

  129. - 预设格式调整配置
  130. ```yaml
  131.   # 预设的格式调整功能
  132.   other-format-presets:
  133.     # 是否删除 %message% 消息 中的格式化字符
  134.     render-message_format-code: false
  135.     # 删除 %message% 消息 前后的空格和空行
  136.     message-trim: true
  137.     # 是否删除 %nick% 群名片 中的格式化字符
  138.     render-nick_format-code: true

  140.     # 聊天消息过长时转换为悬浮文本
  141.     long-message:
  142.       enabled: true
  143.       # 以下任意一个条件成立时被判定为长消息, 若需取消一个, 请改为很大的数
  144.       # 条件1: 消息长度达到此值
  145.       condition-length: 210
  146.       # 条件2: 换行数量达到此值, 在 message-trim 之后运行
  147.       condition-line_num: 6
  148.       # 显示为
  149.       message: '§f[§7长消息§f]'

  151.     # 是否启用 "更好的多行消息"
  152.     multiline-message:
  153.       enabled: true
  154.       line-0: '' # [多行消息]
  155.       line-prefix: '  '

  157.     # 是否将聊天消息转发到控制台/日志
  158.     message-to-log: true
  159. ```

  161. - 引用回复
  162. ```yaml
  163.   # 引用回复
  164.   # 添加变量: %_reply_%
  165.   # 如果是回复消息, 则为变量赋值并为消息添加悬浮文本框用于显示内容. 可以将鼠标悬停在消息上查看回复的内容
  166.   reply-message:
  167.     # 可用变量:
  168.     # %qq% - 被回复的消息的发送者QQ号
  169.     var: '§f[§7回复 @%qq%§f] '

  171.     # 可用变量:
  172.     # %_/n_% - 换行
  173.     # %qq% - 被回复的消息的发送者QQ号
  174.     # %message% - 回复内容
  175.     # %main_message% - 当前消息的完整内容
  176.     message: '§f[§7引用 @%c_name%§f] §7%message%§r%_/n_%%_/n_%§f%main_message%'

  178.     # 删除重复@ :: 如果引用回复对象等于消息开头的@对象, 则删除消息开头的 @
  179.     del-duplicates-at: true
  180. ```

  182. - `qchat` 指令
  183. ```yaml
  184.   # 发送消息的指令
  185.   # /qchat <消息>  - 玩家使用此指令
  186.   # /qchat [自定义名称] <消息>  - 非玩家实体或其他程序使用此指令
  187.   qchat:
  188.     # 使用上方 general.group-ids 中配置的群
  189.     use-general-group-ids: true
  190.     # 消息转发到哪些群, 需要 use-general-group-ids: false
  191.     group-ids:
  192.       - 1000000
  193.     # 非玩家 执行指令时忽略 [自定义名称] 参数
  194.     use-fill-name: false
  195.     # 如果获取不到名称 (开启 auto-other-name 或参数不足) 则使用以下设定值
  196.     fill-name: '控制台'
  197.     # 转发到QQ群的格式
  198.     # %name% - 玩家名称或自定义名称或 fill-other-name
  199.     # %message% - 消息
  200.     qq-format: '[%name%] %message%'
  201.     # 是否同时将消息广播到MC服务器
  202.     mc-broadcast: true
  203.     # 广播到MC服务器的
  204.     mc-format: '§f[§7%name%§f] §r%message%'
  205. ```

  207. - [前置] 群成员信息缓存
  208. ```yaml
  209.   # [前置] 群成员信息缓存, 测试功能
  210.   player-cache:
  211.     # 在指定机器人登录时运行此程序
  212.     enabled: true
  213.     # 自动更新缓存
  214.     auto-update: true
  215.     # 测试.自动更新时重建所有缓存数据
  216.     #test-auto-update-all: false

  218.     # 使用上方 general.group-ids 中配置的群
  219.     use-general-group-ids: true
  220.     # 缓存哪些群, 需要 use-general-group-ids: false
  221.     group-ids:
  222.       - 1000000
  223. ```

  225. - 使用 @群名片
  226. ```yaml
  227.   # 将 %message% 中的 [url=home.php?mod=space&uid=3929123]@qqid[/url] 替换为 @名称
  228.   # 需要开启 aplini.player-cache
  229.   format-qq-id:
  230.     enabled: true
  231.     # 用于匹配 @qqID 的正则
  232.     regular: '(@[0-9]{5,11})'
  233.     # 格式
  234.     # %qq% - qq号
  235.     # %name% - 名称
  236.     format: '[@%name%]'
  237.     # 最多匹配几次, 防止刷屏浪费性能
  238.     max-cycles-num: 7
  239. ```

  241. **指令和权限**
  242. ```yaml
  243. commands:
  244.   qchat:
  245.     description: 发送聊天消息到QQ群
  246.     permission: chat2qq.command.qchat
  247.   chat2qq:
  248.     description: Chat2QQ 插件主命令
  249. permissions:
  250.   chat2qq.join.silent:
  251.     description: 允许悄悄加入服务器
  252.     default: false
  253.   chat2qq.quit.silent:
  254.     description: 允许悄悄离开服务器
  255.     default: false
  256.   chat2qq.command.qchat:
  257.     description: 允许使用 /qchat
  258.     default: op
  259.   chat2qq.command.chat2qq:
  260.     description: 允许使用 /chat2qq
  261.     default: op
  262.   chat2qq:.command.setgroupcacheall:
  263.     description: 允许使用 /chat2qq setgroupcacheall
  264.     default: op
  265. ```
复制代码