Merge remote-tracking branch 'origin/main'

# Conflicts: # docs/.vitepress/zh-CN.ts # docs/zh-CN/develop/api.md
LLOneBot · Oct 24, 2024 · 1d61ed0 · 1d61ed0
2 parents 93d6601 + b6dfcf7
commit 1d61ed0
Show file tree

Hide file tree

Showing 14 changed files with 247 additions and 150 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -13,12 +13,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Use Node.js 
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20.x
           registry-url: https://registry.npmjs.org

diff --git a/README.md b/README.md
@@ -1,3 +1,2 @@
 # LLOneBotDoc
- LLOneBotDoc<br>
-[nonebot2](docs/zh-CN/guide/nonebot2.md)
+LLOneBot 文档
diff --git a/docs/.vitepress/zh-CN.ts b/docs/.vitepress/zh-CN.ts
@@ -1,8 +1,4 @@
-import { createRequire } from 'module'
-import { defineConfig, type DefaultTheme } from 'vitepress'
-
-const require = createRequire(import.meta.url)
-const pkg = require('vitepress/package.json')
+import { defineConfig } from 'vitepress'
 
 export const zhCN = defineConfig({
     lang: 'zh-CN',
@@ -64,7 +60,7 @@ function sidebarGuide() {
                 { text: '开发对接', link: 'develop/quick-start', activeMatch: '/zh-CN/develop/quick-start' },
                 { text: 'API示例', link: 'develop/api', activeMatch: '/zh-CN/develop/api' },
                 { text: '常见问题', link: 'guide/faq', activeMatch: '/zh-CN/guide/' },
-                { text: 'NoneBot2对接', link: 'guide/nonebot2', activeMatch: '/zh-CN/guide/' },
+                { text: '从零安装 NoneBot2', link: 'guide/nonebot2', activeMatch: '/zh-CN/guide/' }
             ]
         }, {
             text: '进阶配置',
@@ -81,10 +77,10 @@ function sidebarDevelop() {
             collapsed: false,
             items: [
                 { text: '快速开始', link: 'develop/quick-start', activeMatch: '/zh-CN/develop/' },
-                { text: 'API列表', link: 'develop/api', activeMatch: '/zh-CN/develop/api' },
+                { text: 'API 列表', link: 'develop/api', activeMatch: '/zh-CN/develop/api' },
                 { text: '上报事件', link: 'develop/event', activeMatch: '/zh-CN/develop/event' },
                 { text: '消息类型', link: 'develop/msg', activeMatch: '/zh-CN/develop/msg' },
-                { text: '扩展API', link: 'develop/extends_api', activeMatch: '/zh-CN/develop/extends_api' },
+                { text: '扩展 API', link: 'develop/extends_api', activeMatch: '/zh-CN/develop/extends_api' },
             ]
         }
     ];

diff --git a/docs/zh-CN/develop/api.md b/docs/zh-CN/develop/api.md
@@ -1,4 +1,6 @@
-## API 详细说明
+# API 列表
+
+LLOneBot 实现了 OneBot 11 以及 go-cqhttp 的大部分 API
 
 接口详细示例: [点击跳转](https://api.napneko.com)
 
@@ -8,29 +10,33 @@
 | HTTP 接口调用      | ✔ |
 | HTTP 事件上报      | ✔ |
 | HTTP POST 快速操作 | ✔ |
-| 正向WS连接         | ✔ |
-| 反向WS连接         | ✔ |
+| 正向 WS 连接       | ✔ |
+| 反向 WS 连接       | ✔ |
+
+## API 支持情况
 
+### OneBot 11
 
+::: tip
+详细用法参阅 [OneBot 11 文档](https://github.com/botuniverse/onebot-11/blob/master/api/public.md)
+:::
 
-## Api 支持情况
-::: details OneBot V11
-| 功能 |     Api    |可用| 备注 |
+| 功能 |     API    |可用| 备注 |
 | --- | -------------  |:--:| -------------- | 
 | 获取 bot 账号信息 |   get_login_info | ✔ | |
 | 发送消息 |   send_msg | ✔ |
 | 发送群聊消息 |   send_group_msg | ✔ |
-| 发送好友消息 |   send_private_msg | ✔ | 不支持临时消息 |
+| 发送好友消息 |   send_private_msg | ✔ | 不支持主动临时消息 |
 | 获取消息详情 |   get_msg | ✔ |
 | 撤回消息 |   delete_msg | ✔ |
-| 点赞 |   send_like | ✔ | 支持给群员点赞 |
+| 发送好友赞 |   send_like | ✔ | |
 | 获取好友列表 |   get_friend_list | ✔ |
 | 处理好友请求 |   set_friend_add_request | ✔ |
 | 获取群列表 |   get_group_list | ✔ |
 | 获取群信息 |   get_group_info | ✔ |
 | 获取群成员列表 |   get_group_member_list | ✔ |
 | 获取群成员信息 |   get_group_member_info | ✔ |
-| 获取群荣誉信息 | get_group_honor_info | ❌ |
+| 获取群荣誉信息 | get_group_honor_info | ✔ |
 | 设置群组专属头衔 |   set_group_special_title | ❌ |
 | 群匿名禁言 |   set_group_anonymous_ban | ❌ |
 | 开关群匿名 |   set_group_anonymous | ❌ |
@@ -42,7 +48,7 @@
 | 设置管理员 |   set_group_admin | ✔ |
 | 设置群名片 |   set_group_card | ✔ |
 | 设置群名 |   set_group_name | ✔ |
-| 获取陌生人信息 |   get_stranger_info | ✔ | 实际上只能获取群员信息 |
+| 获取陌生人信息 |   get_stranger_info | ✔ | |
 | 获取版本信息 |   get_version_info | ✔ |
 | 获取状态 |   get_status | ✔ |
 | 检查能否发送图片 |   can_send_image | ✔ |
@@ -55,16 +61,60 @@
 | 获取 QQ 相关接口凭证 |  get_credentials | ❌ |
 | 重启 OneBot 实现 | set_restart | ❌ |
 | 清理缓存 | clean_cache | ✔ |
-::: 
 
-::: details Go-CQHTTP Api 支持情况
-|     Api    |可用|
-| -------------  |:--:|
-|   send_forward_msg | ✔ |
-|   send_private_forward_msg | ✔ |
-|   send_group_forward_msg | ✔ |
-|   get_group_msg_history | ✔ |
-|   get_forward_msg | ✔ |
-|   upload_group_file | ✔ |
-|   download_file | ✔ |
-:::
+### Go-CQHTTP
+
+::: tip
+详细用法参阅 [go-cqhttp 文档](https://docs.go-cqhttp.org/api/)
+:::
+
+| 功能 |     API    |可用|
+| --- | -------------  |:--:|
+| 发送合并转发 ( 好友 ) | send_private_forward_msg | ✔ |
+| 发送合并转发 ( 群聊 ) | send_group_forward_msg | ✔ |
+| 获取群消息历史记录 | get_group_msg_history | ✔ |
+| 获取合并转发内容 | get_forward_msg | ✔ |
+| 上传群文件 | upload_group_file | ✔ |
+| 上传私聊文件 | upload_private_file | ✔ |
+| 下载文件到缓存目录 | download_file | ✔ |
+| 设置精华消息 | set_essence_msg | ✔ |
+| 移出精华消息 | delete_essence_msg | ✔ |
+| 删除群文件 | delete_group_file | ✔ |
+| 创建群文件文件夹 | create_group_file_folder | ✔ |
+| 删除群文件文件夹 | delete_group_folder | ✔ |
+| 获取群系统消息 | get_group_system_msg | ✔ |
+| 获取群 @全体成员 剩余次数 | get_group_at_all_remain | ✔ |
+| 获取群根目录文件列表 | get_group_root_files | ✔ |
+| 发送群公告 | _send_group_notice | ✔ |
+| 标记消息已读 | mark_msg_as_read | ✔ |
+| 获取群子目录文件列表 | get_group_files_by_folder | ✔ |
+| 获取精华消息列表 | get_essence_msg_list | ✔ |
+| 获取群文件资源链接 | get_group_file_url | ✔ |
+| 获取群公告 | _get_group_notice | ✔ |
+| 删除好友 | delete_friend | ✔ |
+| 图片 OCR | ocr_image | ✔ |
+
+### LLOneBot
+
+::: tip
+详细用法参阅 [扩展 API](./extends_api.md)
+:::
+
+| 功能 |     API    |可用|
+| --- | -------------  |:--:|
+| 设置头像 | set_qq_avatar | ✔ |
+| 获取文件信息 | get_file | ✔ |
+| 获取已过滤的加群通知 | get_group_ignore_add_request | ✔ |
+| 转发单条信息到私聊 | forward_friend_single_msg | ✔ |
+| 转发单条信息到群聊 | forward_group_single_msg | ✔ |
+| 设置消息的表情回应 | set_msg_emoji_like | ✔ |
+| 获取好友分类列表 | get_friends_with_category | ✔ |
+| 设置自身在线状态 | set_online_status | ✔ |
+| 获取自身点赞列表 | get_profile_like | ✔ |
+| 发送合并转发消息 | send_forward_msg | ✔ |
+| 获取收藏表情 | fetch_custom_face | ✔ |
+| 获取好友历史消息记录 | get_friend_msg_history | ✔ |
+| 获取表情回应列表 | fetch_emoji_like | ✔ |
+| 获取官方机器人 QQ 号区间 | get_robot_uin_range | ✔ |
+| 好友戳一戳 | friend_poke | ✔ |
+| 群组戳一戳 | group_poke | ✔ |
diff --git a/docs/zh-CN/develop/event.md b/docs/zh-CN/develop/event.md
@@ -1,3 +1,5 @@
+# 上报事件
+
 ## 事件详细说明
 
 见 <https://docs.go-cqhttp.org/event>
@@ -19,8 +21,8 @@
 | 群禁言     | ✔ | |
 | 群成员名片变更 | ✔ | |
 | 群成员头衔变更 | ✔ | |
-| 群内戳一戳   | ✔ | 暂时只支持 Windows 版本的LLOneBot， 残缺状态，识别不了谁戳的，戳的谁 |
-| 好友戳一戳   | ✔ | 暂时只支持 Windows 版本的LLOneBot |
+| 群内戳一戳   | ✔ | |
+| 好友戳一戳   | ✔ | |
 | 群红包运气王  | ❌ | |
 | 群成员荣誉变更 | ❌ | |
 | 生命周期    | ✔ | 目前只有 ws 的 connect |

diff --git a/docs/zh-CN/develop/extends_api.md b/docs/zh-CN/develop/extends_api.md
@@ -1,5 +1,4 @@
-
-### 扩展api
+# 扩展 API
 
 ::: details 发送文件名自定义
 发送文件时支持参数 `name` 用于自定义显示的文件名
@@ -33,18 +32,15 @@
 ```
 :::
 
-::: details 设置头像api
-`/set_qq_avatar`
+::: details 设置头像 `/set_qq_avatar`
 ```json5
 {
   "file": "file://D:/1.jpg"  // 支持http://, base64://
 }
 ```
 :::
 
-::: details 获取已过滤的加群通知
-
-`/get_group_ignore_add_request`
+::: details 获取已过滤的加群通知 `/get_group_ignore_add_request`
 
 return
 
@@ -69,9 +65,7 @@ return
 相比于 go-cq 多了个 `target_id` 字段表示发送的目标QQ号或者群号
 :::
 
-::: details 下载收到的群文件或私聊文件
-
-`/get_file`
+::: details 下载收到的群文件或私聊文件 `/get_file`
 
 ```json5
 {
@@ -97,13 +91,14 @@ return
 ```
 :::
 
-::: details /download_file
-与 gocq 用法一样，但是支持 base64 参数用于直接下载 base64 编码的文件
+::: details 支持 base64 参数用于直接下载 base64 编码的文件
+
+`/download_file`
 
 ::: tip 此 api 不适用于下载群文件或者私聊文件
 :::
 
-::: details 转发单条消息到好友 /forward_friend_single_msg
+::: details 转发单条消息到好友 `/forward_friend_single_msg`
 
 ```json5
 {
@@ -114,7 +109,7 @@ return
 :::
 
 
-::: details 转发单条消息到群 /forward_group_single_msg
+::: details 转发单条消息到群 `/forward_group_single_msg`
 
 ```json5
 {
@@ -124,7 +119,7 @@ return
 ```
 :::
 
-::: details 发送表情回应 /set_msg_emoji_like
+::: details 发送表情回应 `/set_msg_emoji_like`
 ```json5
 {
     "message_id": "-2147480026",
@@ -134,7 +129,7 @@ return
 emoji_id 参考 <https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType>
 :::
 
-::: details 获取带分组信息好友列表 /get_friends_with_category
+::: details 获取带分组信息好友列表 `/get_friends_with_category`
 
 return:
 ```json5
@@ -190,4 +185,59 @@ return:
   ]
 }
 ```
-:::
+:::
+
+::: details 设置自身在线状态 `/set_online_status`
+
+在线:
+```json
+{ "status": 10, "ext_status": 0, "battery_status": 0 }
+```
+离开:
+```json
+{ "status": 30, "ext_status": 0, "battery_status": 0 }
+```
+隐身:
+```json
+{ "status": 40, "ext_status": 0, "battery_status": 0 }
+```
+忙碌:
+```json
+{ "status": 50, "ext_status": 0, "battery_status": 0 }
+```
+Q我吧:
+```json
+{ "status": 60, "ext_status": 0, "battery_status": 0 }
+```
+请勿打扰:
+```json
+{ "status": 70, "ext_status": 0, "battery_status": 0 }
+```
+:::
+
+::: details 获取自身点赞列表 `/get_profile_like`
+
+请求时无需参数
+
+:::
+
+::: details 好友戳一戳 `/friend_poke`
+
+```json
+{
+    "user_id": 123456
+}
+```
+
+:::
+
+::: details 群组戳一戳 `/group_poke`
+
+```json
+{
+    "group_id": 123456,
+    "user_id": 123456
+}
+```
+
+:::