From 001dfc4db2dd8fde9c13b25bae3a40141d366e74 Mon Sep 17 00:00:00 2001 From: linyuchen Date: Tue, 27 Feb 2024 03:15:25 +0800 Subject: [PATCH] docs: update readme --- README.md | 94 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 57 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 4f59484..71ccda1 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ TG群: *插件目录:`LiteLoaderQQNT/plugins`* +安装后的目录结构如下 +``` +├── plugins +│ ├── LLOneBot +│ │ └── main.js +│ │ └── preload.js +│ │ └── renderer.js +│ │ └── manifest.json +│ │ └── node_modules/... +``` + ## 支持的API 目前支持的协议 @@ -42,10 +53,11 @@ TG群: - [x] 上报好友、群消息撤回 - [x] 上报加群请求 - [x] 上报群员人数变动(尚不支持识别群员人数变动原因) -- [ ] 群禁言 -- [ ] 群踢人 -- [ ] 群改群成员名片 -- [ ] 修改群名 +- [x] 设置群管理员 +- [x] 群禁言/全体禁言 +- [x] 群踢人 +- [x] 群改群成员名片 +- [x] 修改群名 消息格式支持: - [x] cq码 @@ -57,37 +69,11 @@ TG群: - [x] 语音(支持mp3、wav等多种音频格式直接发送) - [x] json消息(只上报) - [x] 转发消息记录(目前只能发不能收) +- [x] 视频(只能上报本地路径) +- [x] 文件(只能上报本地路径) - [ ] 发送音乐卡片 -- [ ] 视频 -- [ ] 文件 -- [ ] 红包 -- [ ] xml - -支持的api: -- [x] get_login_info -- [x] send_msg -- [x] send_group_msg -- [x] send_private_msg -- [x] delete_msg -- [x] get_group_list -- [x] get_group_info -- [x] get_group_member_list -- [x] get_group_member_info -- [x] get_friend_list -- [x] set_friend_add_request -- [x] get_msg -- [x] send_like -- [x] set_group_add_request -- [x] set_group_leave -- [x] get_version_info -- [x] get_status -- [x] can_send_image -- [x] can_send_record - -支持的go-cqhtp api: -- [x] send_private_forward_msg -- [x] send_group_forward_msg -- [x] get_stranger_info +- [ ] 红包(没有计划支持) +- [ ] xml (没有计划支持) ## 示例 @@ -106,6 +92,7 @@ TG群: 调用接口报404
目前没有支持全部的onebot规范接口,请检查是否调用了不支持的接口 +-
@@ -123,16 +110,49 @@ TG群:
+## 支持的onebot v11 api: +- [x] get_login_info +- [x] send_msg +- [x] send_group_msg +- [x] send_private_msg +- [x] delete_msg +- [x] get_group_list +- [x] get_group_info +- [x] get_group_member_list +- [x] get_group_member_info +- [x] get_friend_list +- [x] set_friend_add_request +- [x] get_msg +- [x] send_like +- [x] set_group_add_request +- [x] set_group_leave +- [x] set_group_kick +- [x] set_group_ban +- [x] set_group_whole_ban +- [x] set_group_kick +- [x] set_group_admin +- [x] set_group_card +- [x] set_group_name +- [x] get_version_info +- [x] get_status +- [x] can_send_image +- [x] can_send_record + +### 支持的go-cqhtp api: +- [x] send_private_forward_msg +- [x] send_group_forward_msg +- [x] get_stranger_info ## TODO - [x] 重构摆脱LLAPI,目前调用LLAPI只能在renderer进程调用,需重构成在main进程调用 - [x] 支持正、反向websocket(感谢@disymayufei的PR) - [x] 转发消息记录 - [x] 好友点赞api -- [ ] 群管理功能,禁言、踢人,改群名片等 -- [ ] 视频消息 -- [ ] 文件消息 +- [x] 群管理功能,禁言、踢人,改群名片等 +- [x] 视频消息 +- [x] 文件消息 - [ ] 音乐卡片 +- [ ] 无头模式 ## onebot11文档