/cqhttp-mirai

为Mirai移植的CQHTTP插件以兼容基于CQHTTP API开发的应用 - CQHTTP port for Mirai

Primary LanguageKotlinGNU Affero General Public License v3.0AGPL-3.0

CQHTTP Mirai

CQHTTP runs on Mirai

开始使用

  1. 请首先运行Mirai-console相关客户端生成plugins文件夹
  2. 将cqhttp-mirai生成的jar包文件放入plugins文件夹中
  3. 编辑plugins/CQHTTPMirai/setting.yml配置文件, 将以下给出配置复制并修改
  4. 再次启动Mirai-console相关客户端

配置相关

# 要进行配置的QQ号 (Mirai支持多帐号登录, 故需要对每个帐号进行单独设置)
'1234567890':
    # HTTP 相关配置
    http:
        # 可选，事件及数据上报URL, 默认为空, 即不上报
        postUrl: ""
        # 可选，上报消息格式，string 为字符串格式，array 为数组格式, 默认为string
        postMessageFormat: string
        # 可选，上报数据签名密钥, 默认为空
        secret: ""
    # 可选，反向客户端服务
    ws_reverse:
        # 可选，是否启用反向客户端，默认不启用
        enable: true
        # 上报消息格式，string 为字符串格式，array 为数组格式, 默认为string
        postMessageFormat: string
        # 反向Websocket主机
        reverseHost: 127.0.0.1
        # 反向Websocket端口
        reversePort: 8080
        # 反向Websocket路径
        reversePath: /ws
        # 访问口令, 默认为null, 即不设置Token
        accessToken: null
        # 反向Websocket Api路径 尚未实现
        #  reverseApiPath: /ws/
        # 反向Websocket Event路径 尚未实现
        #  reverseEventPath: /ws/
        # 反向 WebSocket 客户端断线重连间隔，单位毫秒
        reconnectInterval: 3000

计划

  • 反向Websocket客户端
  • HTTP上报服务
  • HTTP API
  • Websocket服务端

已经支持的CQHTTP API

特别注意, 很多信息Mirai不支持获取, 如群成员的年龄、性别等, 为保证兼容性, 这些项已用Unknown, 0之类的信息填充占位

  • SendMessage (不包含讨论组消息)
  • SendGroupMessage
  • SendPrivateMessage
  • DeleteMessage
  • SetGroupKick
  • SetGroupBan
  • SetWholeGroupBan
  • SetGroupCard
  • SetGroupLeave
  • SetFriendAddRequest
  • GetLoginInfo
  • GetFriendList
  • GetGroupList
  • GetGroupInfo (不支持获取群容量, 返回0)
  • GetGroupMemberInfo
  • GetGroupMemberList
  • CanSendImage (恒为true)
  • GetStatus (不完全支持, 仅返回online和good两项)
  • GetVersionInfo

尚未支持的CQHTTP API

  • GetImage
  • SetRestartPlugin
  • CleanDataDir
  • CleanPluginLog
  • GetCookies (Mirai不会支持)
  • GetCSRFToken (Mirai不会支持)
  • GetRecord
  • GetCredentials
  • GetStrangerInfo
  • SendDiscussMessage
  • SetGroupAnonymous
  • SetGroupAdmin
  • SetDiscussLeave
  • SendLike (Mirai不会支持)
  • SetAnonymousBan

开源协议

AGPL-3.0 © yyuueexxiinngg

直接或间接引用到的其他开源项目