diff --git a/README.md b/README.md new file mode 100644 index 0000000..99469b8 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# go-cqhttp +使用 [mirai](https://github.com/mamoe/mirai) 以及 [MiraiGo](https://github.com/Mrs4s/MiraiGo) 开发的cqhttp golang原生实现, 并在[cqhttp原版](https://github.com/richardchien/coolq-http-api)的基础上做了部分修改和拓展. + +# 兼容性 +#### 接口 +- [x] HTTP API +- [ ] 反向HTTP POST (开发中) +- [x] 正向Websocket +- [ ] 反向Websocket (开发中) +#### 实现 +
+已实现API + +##### 注意: 部分API实现与CQHTTP原版略有差异,请参考WIKI +| API | 功能 | +| ------------------------ | ------------------------------------------------------------ | +| /get_login_info | [获取登录号信息](https://cqhttp.cc/docs/4.15/#/API?id=get_login_info-获取登录号信息) | +| /get_friend_list | [获取好友列表](https://cqhttp.cc/docs/4.15/#/API?id=get_friend_list-获取好友列表) | +| /get_group_list | [获取群列表](https://cqhttp.cc/docs/4.15/#/API?id=get_group_list-获取群列表) | +| /get_group_info | [获取群信息](https://cqhttp.cc/docs/4.15/#/API?id=get_group_info-获取群信息) | +| /get_group_member_list | [获取群成员列表](https://cqhttp.cc/docs/4.15/#/API?id=get_group_member_list-获取群成员列表) | +| /get_group_member_info | [获取群成员信息](https://cqhttp.cc/docs/4.15/#/API?id=get_group_member_info-获取群成员信息) | +| /send_msg | [发送消息](https://cqhttp.cc/docs/4.15/#/API?id=send_msg-发送消息) | +| /send_group_msg | [发送群消息](https://cqhttp.cc/docs/4.15/#/API?id=send_group_msg-发送群消息) | +| /send_private_msg | [发送私聊消息](https://cqhttp.cc/docs/4.15/#/API?id=send_private_msg-发送私聊消息) | +| /delete_msg | [撤回信息](https://cqhttp.cc/docs/4.15/#/API?id=delete_msg-撤回消息) | +| /set_friend_add_request | [处理加好友请求](https://cqhttp.cc/docs/4.15/#/API?id=set_friend_add_request-处理加好友请求) | +| /set_group_add_request | [处理加群请求/邀请](https://cqhttp.cc/docs/4.15/#/API?id=set_group_add_request-处理加群请求/邀请) | +| /set_group_card | [设置群名片(群备注)](https://cqhttp.cc/docs/4.15/#/API?id=set_group_card-设置群名片(群备注)) | +| /set_group_special_title | [设置群组专属头衔](https://cqhttp.cc/docs/4.15/#/API?id=set_group_special_title-设置群组专属头衔) | +| /set_group_kick | [群组T人](https://cqhttp.cc/docs/4.15/#/API?id=set_group_kick-群组踢人) | +| /set_group_ban | [群组单人禁言](https://cqhttp.cc/docs/4.15/#/API?id=set_group_ban-群组单人禁言) | +| /set_group_whole_ban | [群组全员禁言](https://cqhttp.cc/docs/4.15/#/API?id=set_group_whole_ban-群组全员禁言) | +| /set_group_name | 设置群组名(拓展API) | +| /get_image | 获取图片信息(拓展API) | +| /get_group_msg | 获取群组消息(拓展API) | +| /can_send_image | [检查是否可以发送图片](https://cqhttp.cc/docs/4.15/#/API?id=can_send_image-检查是否可以发送图片) | +| /can_send_record | [检查是否可以发送语音](https://cqhttp.cc/docs/4.15/#/API?id=can_send_record-检查是否可以发送语音) | +| /get_status | [获取插件运行状态](https://cqhttp.cc/docs/4.15/#/API?id=get_status-获取插件运行状态) | +| /get_version_info | [获取 酷Q 及 CQHTTP插件的版本信息](https://cqhttp.cc/docs/4.15/#/API?id=get_version_info-获取-酷q-及-cqhttp-插件的版本信息) | + +
+ +
+已实现Event + +##### 注意: 部分Event数据与CQHTTP原版略有差异,请参考WIKI +| Event | +| ------------------------------------------------------------ | +| [私聊信息](https://cqhttp.cc/docs/4.15/#/Post?id=私聊消息) | +| [群消息](https://cqhttp.cc/docs/4.15/#/Post?id=群消息) | +| 群消息撤回(拓展Event) | +| [群管理员变动](https://cqhttp.cc/docs/4.15/#/Post?id=群管理员变动) | +| [群成员减少](https://cqhttp.cc/docs/4.15/#/Post?id=群成员减少) | +| [群成员增加](https://cqhttp.cc/docs/4.15/#/Post?id=群成员增加) | +| [群禁言](https://cqhttp.cc/docs/4.15/#/Post?id=群禁言) | +| [加好友请求](https://cqhttp.cc/docs/4.15/#/Post?id=加好友请求) | +| [加群请求/邀请](https://cqhttp.cc/docs/4.15/#/Post?id=加群请求/邀请) | + +
+ +# 性能 + +在关闭数据库的情况下, 加载25个好友128个群运行24小时后内存使用为10MB左右. 开启数据库后内存使用将根据消息量增加10-20MB, 如果系统内存小于128M建议关闭数据库使用.