From e79395f4c2b6e4a0d618301e8bf699b5e8523bc2 Mon Sep 17 00:00:00 2001 From: huankong233 Date: Fri, 30 Aug 2024 12:11:15 +0800 Subject: [PATCH 1/2] =?UTF-8?q?chore:=20docs=20-=20=E4=BF=AE=E6=94=B9?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9B=AE=E5=BD=95=E5=85=B3=E7=B3=BB=20-=20?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=85=BC=E5=AE=B9=E6=80=A7=E6=83=85=E5=86=B5?= =?UTF-8?q?=20-=20=E4=BC=98=E5=8C=96=E9=9B=B6=E7=A2=8E=E7=9A=84=E6=95=99?= =?UTF-8?q?=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 + docs/.vitepress/zh-CN.ts | 45 +- docs/zh-CN/develop/NapCat.md | 476 +++++++++--------- docs/zh-CN/develop/about.md | 4 +- docs/zh-CN/develop/api.md | 83 --- docs/zh-CN/develop/compatibility/api.md | 133 +++++ .../develop/{ => compatibility}/event.md | 2 +- docs/zh-CN/develop/{ => compatibility}/msg.md | 4 +- docs/zh-CN/guide/boot/only-gui/BootWay03.md | 5 +- .../boot/shell/BootWay03-Linux-SemiAuto.md | 7 +- docs/zh-CN/guide/boot/shell/BootWay03.md | 6 +- docs/zh-CN/guide/boot/shell/BootWay05.md | 6 +- docs/zh-CN/guide/config/advanced.md | 1 + docs/zh-CN/guide/config/ffmpeg.md | 8 + docs/zh-CN/guide/faq.md | 10 +- docs/zh-CN/guide/getting-started.md | 45 +- docs/zh-CN/guide/integration.md | 1 + docs/zh-CN/guide/resource.md | 3 +- 18 files changed, 463 insertions(+), 378 deletions(-) delete mode 100644 docs/zh-CN/develop/api.md create mode 100644 docs/zh-CN/develop/compatibility/api.md rename docs/zh-CN/develop/{ => compatibility}/event.md (98%) rename docs/zh-CN/develop/{ => compatibility}/msg.md (93%) diff --git a/README.md b/README.md index 7934dd0..8412a80 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ # NapCat + +喵呜(困) diff --git a/docs/.vitepress/zh-CN.ts b/docs/.vitepress/zh-CN.ts index 6b6245f..6a4048f 100644 --- a/docs/.vitepress/zh-CN.ts +++ b/docs/.vitepress/zh-CN.ts @@ -1,8 +1,8 @@ -import { createRequire } from 'module' +// import { createRequire } from 'module' import { defineConfig } from 'vitepress' -const require = createRequire(import.meta.url) -const pkg = require('vitepress/package.json') +// const require = createRequire(import.meta.url) +// const pkg = require('vitepress/package.json') export const zhCN = defineConfig({ lang: 'zh-CN', @@ -49,46 +49,49 @@ export const zhCN = defineConfig({ function nav() { return [ - { text: '使用', link: '/zh-CN/guide/getting-started', activeMatch: '/zh-CN/guide' }, - { text: '开发', link: '/zh-CN/develop/api', activeMatch: '/zh-CN/develop' } + { text: '使用', link: '/zh-CN/guide/getting-started' }, + { text: '开发', link: '/zh-CN/develop/compatibility/api' } ] } + function sidebarGuide() { return [ - { text: '快速开始', link: 'guide/getting-started', activeMatch: '/zh-CN/guide/' }, + { text: '快速开始', link: 'guide/getting-started' }, { text: '配置', items: [ - { text: '基础配置', link: 'guide/config/basic', activeMatch: '/zh-CN/guide/' }, - { text: '进阶配置', link: 'guide/config/advanced', activeMatch: '/zh-CN/guide/' }, + { text: '基础配置', link: '/guide/config/basic' }, + { text: '进阶配置', link: '/guide/config/advanced' }, + { text: 'ffmpeg配置', link: '/guide/config/ffmpeg' } ] }, - { text: '接入框架', link: 'guide/integration', activeMatch: '/zh-CN/guide/' }, - { text: '常见问题', link: 'guide/faq', activeMatch: '/zh-CN/guide/' }, - { text: '社区资源', link: 'guide/resource', activeMatch: '/zh-CN/guide/' }, - // { text: '版本日志', link: 'guide/version', activeMatch: '/zh-CN/guide/' } + { text: '接入框架', link: '/guide/integration' }, + { text: '常见问题', link: '/guide/faq' }, + { text: '社区资源', link: '/guide/resource' } ] } function sidebarDevelop() { return [ + { + text: '兼容情况', + items: [ + { text: '请求接口', link: 'develop/compatibility/api' }, + { text: '上报事件', link: 'develop/compatibility/event' }, + { text: '消息类型', link: 'develop/compatibility/msg' } + ] + }, { text: '开发信息', - collapsed: false, items: [ - { text: 'API List', link: 'develop/api', activeMatch: '/zh-CN/develop/' }, - { 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' + link: 'develop/extends_api' }, { text: '状态列表', - link: 'develop/status_list', - activeMatch: '/zh-CN/develop/status_list' + link: 'develop/status_list' }, - { text: '关于项目', link: 'develop/about', activeMatch: '/zh-CN/develop/about' } + { text: '关于项目', link: 'develop/about' } ] } ] diff --git a/docs/zh-CN/develop/NapCat.md b/docs/zh-CN/develop/NapCat.md index 532b22b..8ae82ed 100644 --- a/docs/zh-CN/develop/NapCat.md +++ b/docs/zh-CN/develop/NapCat.md @@ -49,14 +49,14 @@ POST /send_group_msg ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» group_id|body|integer| 是 |none| -|» message|body|[object]| 是 |none| -|»» data|body|object| 是 |none| -|»»» text|body|string| 是 |none| -|»» type|body|string| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---------- | ---- | -------- | ---- | ---- | +| body | body | object | 否 | none | +| » group_id | body | integer | 是 | none | +| » message | body | [object] | 是 | none | +| »» data | body | object | 是 | none | +| »»» text | body | string | 是 | none | +| »» type | body | string | 是 | none | > 返回示例 @@ -68,9 +68,9 @@ POST /send_group_msg ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -102,14 +102,14 @@ POST /send_private_msg ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» user_id|body|integer| 是 |none| -|» message|body|[object]| 是 |none| -|»» data|body|object| 是 |none| -|»»» text|body|string| 是 |none| -|»» type|body|string| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| --------- | ---- | -------- | ---- | ---- | +| body | body | object | 否 | none | +| » user_id | body | integer | 是 | none | +| » message | body | [object] | 是 | none | +| »» data | body | object | 是 | none | +| »»» text | body | string | 是 | none | +| »» type | body | string | 是 | none | > 返回示例 @@ -121,9 +121,9 @@ POST /send_private_msg ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -142,11 +142,11 @@ POST /get_group_msg_history ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» group_id|body|integer| 是 |none| -|» count|body|integer| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---------- | ---- | ------- | ---- | ---- | +| body | body | object | 否 | none | +| » group_id | body | integer | 是 | none | +| » count | body | integer | 是 | none | > 返回示例 @@ -158,9 +158,9 @@ POST /get_group_msg_history ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -178,9 +178,9 @@ POST /get_robot_uin_range ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | > 返回示例 @@ -220,24 +220,24 @@ POST /get_robot_uin_range ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 状态码 **200** -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» status|string|true|none||none| -|» retcode|integer|true|none||none| -|» data|[object]|true|none||none| -|»» minUin|string|true|none||none| -|»» maxUin|string|true|none||none| -|» message|string|true|none||none| -|» wording|string|true|none||none| -|» echo|null|true|none||none| +| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 | +| --------- | -------- | ---- | ---- | ------ | ---- | +| » status | string | true | none | | none | +| » retcode | integer | true | none | | none | +| » data | [object] | true | none | | none | +| »» minUin | string | true | none | | none | +| »» maxUin | string | true | none | | none | +| » message | string | true | none | | none | +| » wording | string | true | none | | none | +| » echo | null | true | none | | none | ## POST 好友列表与分类获取 @@ -253,10 +253,10 @@ POST /get_friends_with_category ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» no_cache|body|boolean| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---------- | ---- | ------- | ---- | ---- | +| body | body | object | 否 | none | +| » no_cache | body | boolean | 是 | none | > 返回示例 @@ -268,9 +268,9 @@ POST /get_friends_with_category ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -290,12 +290,12 @@ POST /fetch_emoji_like ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» message_id|body|integer| 是 |none| -|» emojiType|body|integer| 是 |none| -|» emojiId|body|integer| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ------------ | ---- | ------- | ---- | ---- | +| body | body | object | 否 | none | +| » message_id | body | integer | 是 | none | +| » emojiType | body | integer | 是 | none | +| » emojiId | body | integer | 是 | none | > 返回示例 @@ -338,31 +338,31 @@ POST /fetch_emoji_like ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 状态码 **200** -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» status|string|true|none||none| -|» retcode|integer|true|none||none| -|» data|object|true|none||none| -|»» result|integer|true|none||none| -|»» errMsg|string|true|none||none| -|»» emojiLikesList|[object]|true|none||none| -|»»» tinyId|string|false|none||none| -|»»» nickName|string|false|none||none| -|»»» headUrl|string|false|none||none| -|»» cookie|string|true|none||none| -|»» isLastPage|boolean|true|none||none| -|»» isFirstPage|boolean|true|none||none| -|» message|string|true|none||none| -|» wording|string|true|none||none| -|» echo|null|true|none||none| +| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 | +| ----------------- | -------- | ----- | ---- | ------ | ---- | +| » status | string | true | none | | none | +| » retcode | integer | true | none | | none | +| » data | object | true | none | | none | +| »» result | integer | true | none | | none | +| »» errMsg | string | true | none | | none | +| »» emojiLikesList | [object] | true | none | | none | +| »»» tinyId | string | false | none | | none | +| »»» nickName | string | false | none | | none | +| »»» headUrl | string | false | none | | none | +| »» cookie | string | true | none | | none | +| »» isLastPage | boolean | true | none | | none | +| »» isFirstPage | boolean | true | none | | none | +| » message | string | true | none | | none | +| » wording | string | true | none | | none | +| » echo | null | true | none | | none | ## POST 获取最近联系人 @@ -378,10 +378,10 @@ POST /get_recent_contact ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» count|body|number| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ------- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | +| » count | body | number | 是 | none | > 返回示例 @@ -393,9 +393,9 @@ POST /get_recent_contact ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -413,10 +413,10 @@ POST /fetch_custom_face ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» count|body|number| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ------- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | +| » count | body | number | 是 | none | > 返回示例 @@ -437,22 +437,22 @@ POST /fetch_custom_face ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 状态码 **200** -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» status|string|true|none||none| -|» retcode|integer|true|none||none| -|» data|[string]|true|none||none| -|» message|string|true|none||none| -|» wording|string|true|none||none| -|» echo|null|true|none||none| +| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 | +| --------- | -------- | ---- | ---- | ------ | ---- | +| » status | string | true | none | | none | +| » retcode | integer | true | none | | none | +| » data | [string] | true | none | | none | +| » message | string | true | none | | none | +| » wording | string | true | none | | none | +| » echo | null | true | none | | none | ## POST 创建文本收藏 @@ -469,11 +469,11 @@ POST /create_collection ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» rawData|body|string| 是 |none| -|» brief|body|string| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| --------- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | +| » rawData | body | string | 是 | none | +| » brief | body | string | 是 | none | > 返回示例 @@ -485,9 +485,9 @@ POST /create_collection ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -506,11 +506,11 @@ POST /get_collection_list ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| -|» category|body|number| 是 |none| -|» count|body|number| 是 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---------- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | +| » category | body | number | 是 | none | +| » count | body | number | 是 | none | > 返回示例 @@ -522,9 +522,9 @@ POST /get_collection_list ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -540,9 +540,9 @@ POST /get_profile_like ### 请求参数 -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|body|body|object| 否 |none| +| 名称 | 位置 | 类型 | 必选 | 说明 | +| ---- | ---- | ------ | ---- | ---- | +| body | body | object | 否 | none | > 返回示例 @@ -554,9 +554,9 @@ POST /get_profile_like ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -574,10 +574,10 @@ POST /ocr_image ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» image|body|string| 是 | 图片|图片路径| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ------- | ---- | ------ | ---- | ------ | -------- | +| body | body | object | 否 | | none | +| » image | body | string | 是 | 图片 | 图片路径 | > 返回示例 @@ -589,9 +589,9 @@ POST /ocr_image ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -610,11 +610,11 @@ POST /set_group_head ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» file|body|string(uri)| 是 | 头像|群头像链接或者路径| -|» groupCode|body|string| 是 | 群号|需要有管理员权限| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ----------- | ---- | ----------- | ---- | ------ | ------------------ | +| body | body | object | 否 | | none | +| » file | body | string(uri) | 是 | 头像 | 群头像链接或者路径 | +| » groupCode | body | string | 是 | 群号 | 需要有管理员权限 | > 返回示例 @@ -626,9 +626,9 @@ POST /set_group_head ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -646,10 +646,10 @@ POST /set_self_longnick ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» longNick|body|string| 是 | 个性签名|none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------ | ---- | -------- | ---- | +| body | body | object | 否 | | none | +| » longNick | body | string | 是 | 个性签名 | none | > 返回示例 @@ -661,9 +661,9 @@ POST /set_self_longnick ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -683,12 +683,12 @@ POST /set_online_status ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» status|body|integer| 是 ||none| -|» extStatus|body|integer| 是 ||none| -|» batteryStatus|body|integer| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| --------------- | ---- | ------- | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » status | body | integer | 是 | | none | +| » extStatus | body | integer | 是 | | none | +| » batteryStatus | body | integer | 是 | | none | > 返回示例 @@ -700,9 +700,9 @@ POST /set_online_status ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -722,12 +722,12 @@ POST /set_self_profile ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» nick|body|string| 是 ||none| -|» longNick|body|string| 是 ||none| -|» sex|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » nick | body | string | 是 | | none | +| » longNick | body | string | 是 | | none | +| » sex | body | string | 是 | | none | > 返回示例 @@ -739,9 +739,9 @@ POST /set_self_profile ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -761,12 +761,12 @@ POST /ArkSharePeer ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» user_id|body|string| 否 ||none| -|» group_id|body|string| 否 ||none| -|» phoneNumber|body|string| 否 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ------------- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » user_id | body | string | 否 | | none | +| » group_id | body | string | 否 | | none | +| » phoneNumber | body | string | 否 | | none | > 返回示例 @@ -778,9 +778,9 @@ POST /ArkSharePeer ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -798,10 +798,10 @@ POST /ArkShareGroupEx ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» group_id|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » group_id | body | string | 是 | | none | > 返回示例 @@ -813,9 +813,9 @@ POST /ArkShareGroupEx ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -833,10 +833,10 @@ POST /mark_group_msg_as_read ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» group_id|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » group_id | body | string | 是 | | none | > 返回示例 @@ -848,9 +848,9 @@ POST /mark_group_msg_as_read ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -868,10 +868,10 @@ POST /mark_private_msg_as_read ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» group_id|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » group_id | body | string | 是 | | none | > 返回示例 @@ -883,9 +883,9 @@ POST /mark_private_msg_as_read ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -909,10 +909,10 @@ POST /translate_en2zh ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» words|body|[string]| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ------- | ---- | -------- | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » words | body | [string] | 是 | | none | > 返回示例 @@ -924,9 +924,9 @@ POST /translate_en2zh ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -946,9 +946,9 @@ POST /get_friend_list ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | > 返回示例 @@ -960,9 +960,9 @@ POST /get_friend_list ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -980,9 +980,9 @@ POST /get_stranger_info ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | > 返回示例 @@ -996,17 +996,17 @@ POST /get_stranger_info ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 状态码 **200** -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» user_id|string|true|none||none| +| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 | +| --------- | ------ | ---- | ---- | ------ | ---- | +| » user_id | string | true | none | | none | # 群组接口 @@ -1026,12 +1026,12 @@ POST /get_group_member_info ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» no_cache|body|boolean| 是 ||none| -|» group_id|body|string| 是 ||none| -|» user_id|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------- | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » no_cache | body | boolean | 是 | | none | +| » group_id | body | string | 是 | | none | +| » user_id | body | string | 是 | | none | > 返回示例 @@ -1043,9 +1043,9 @@ POST /get_group_member_info ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -1064,11 +1064,11 @@ POST /get_group_member_list ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| -|» no_cache|body|boolean| 是 ||none| -|» group_id|body|string| 是 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---------- | ---- | ------- | ---- | ------ | ---- | +| body | body | object | 否 | | none | +| » no_cache | body | boolean | 是 | | none | +| » group_id | body | string | 是 | | none | > 返回示例 @@ -1080,9 +1080,9 @@ POST /get_group_member_list ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 @@ -1103,9 +1103,9 @@ POST /group_poke ### 请求参数 -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|body|body|object| 否 ||none| +| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 | +| ---- | ---- | ------ | ---- | ------ | ---- | +| body | body | object | 否 | | none | > 返回示例 @@ -1117,9 +1117,9 @@ POST /group_poke ### 返回结果 -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| +| 状态码 | 状态码含义 | 说明 | 数据模型 | +| ------ | ------------------------------------------------------- | ---- | -------- | +| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | ### 返回数据结构 diff --git a/docs/zh-CN/develop/about.md b/docs/zh-CN/develop/about.md index c0a4fa8..dc13fb7 100644 --- a/docs/zh-CN/develop/about.md +++ b/docs/zh-CN/develop/about.md @@ -1,3 +1,5 @@ # 关于 -[QQ群 545402644](https://qm.qq.com/q/CKRbpb8H3a) +[LLOneBot & NapCat #1](https://qm.qq.com/q/CKRbpb8H3a) + +[LLOneBot & NapCat #2](https://qm.qq.com/q/haLGHixZ74) diff --git a/docs/zh-CN/develop/api.md b/docs/zh-CN/develop/api.md deleted file mode 100644 index 4df2fb4..0000000 --- a/docs/zh-CN/develop/api.md +++ /dev/null @@ -1,83 +0,0 @@ -# API List - -NapCatQQ 实现了 [OneBot 11](https://11.onebot.dev/) 以及 [go-cqhttp](https://docs.go-cqhttp.org/api) 的大部分 API，对于 API 的详细说明请自行点击相关链接查看。 - -## 连接方式支持情况 - -| 连接方式 | 可用 | -| ------------------ | :---: | -| HTTP 接口调用 | ✔ | -| HTTP POST 事件上报 | ✔ | -| HTTP POST 快速操作 | ✔ | -| 正向 WS 连接 | ✔ | -| 反向 WS 连接 | ✔ | - -## API 支持情况 - -::: details OneBot 11 API - -| 功能 | Api | 可用 | 备注 | -| -------------------- | ----------------------- | :---: | ---------------------- | -| 获取 bot 账号信息 | get_login_info | ✔ | | -| 发送消息 | send_msg | ✔ | | -| 发送群聊消息 | send_group_msg | ✔ | | -| 发送好友消息 | send_private_msg | ✔ | 不支持主动临时消息 | -| 获取消息详情 | get_msg | ✔ | | -| 撤回消息 | delete_msg | ✔ | | -| 点赞 | 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 | ✔ | | -| 设置群组专属头衔 | set_group_special_title | ❌ | | -| 群匿名禁言 | set_group_anonymous_ban | ❌ | | -| 开关群匿名 | set_group_anonymous | ❌ | | -| 处理加群请求 | set_group_add_request | ✔ | | -| 退群 | set_group_leave | ✔ | | -| 群踢人 | set_group_kick | ✔ | | -| 群禁言 | set_group_ban | ✔ | | -| 全群禁言 | set_group_whole_ban | ✔ | | -| 设置管理员 | set_group_admin | ✔ | | -| 设置群名片 | set_group_card | ✔ | | -| 设置群名 | set_group_name | ✔ | | -| 获取陌生人信息 | get_stranger_info | ✔ | | -| 获取版本信息 | get_version_info | ✔ | | -| 获取状态 | get_status | ✔ | | -| 检查能否发送图片 | can_send_image | ✔ | | -| 检查能否发送语音 | can_send_record | ✔ | | -| 获取图片详情 | get_image | ✔ | | -| 获取语音文件 | get_record | ✔ | | -| 获取文件详情 | get_file | ✔ | | -| 获取 Cookies | get_cookies | ✔ | | -| 获取 CSRF Token | get_csrf_token | ❌ | | -| 获取 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_forward_msg | ✔ | -| upload_group_file | ✔ | -| download_file | ✔ | -| get_essence_msg_list | ✔ | -| _get_group_notice | ✔ | -| _send_group_notice | ✔ | -| _del_group_notice | ✔ | -| get_group_system_msg | ✔ | -| ocr_image | ✔ | -| get_online_clients | ✔ | - -::: - -## 接口文档 -[完整参考文档](./NapCat.md) diff --git a/docs/zh-CN/develop/compatibility/api.md b/docs/zh-CN/develop/compatibility/api.md new file mode 100644 index 0000000..0e76600 --- /dev/null +++ b/docs/zh-CN/develop/compatibility/api.md @@ -0,0 +1,133 @@ +# 请求接口兼容情况 + +NapCatQQ 实现了 [OneBot 11](https://11.onebot.dev/) 以及 [go-cqhttp](https://docs.go-cqhttp.org/api) 的大部分 API，对于 API 的详细说明请自行点击相关链接查看。 + +## 连接方式 + +| 连接方式 | 可用 | +| ------------------ | :---: | +| HTTP 接口调用 | ✔ | +| HTTP POST 事件上报 | ✔ | +| HTTP POST 快速操作 | ✔ | +| 正向 WS 连接 | ✔ | +| 反向 WS 连接 | ✔ | + +## OneBot 11 API + +| Api | 介绍 | 可用 | 备注 | +| ------------------------- | -------------------- | :---: | -------------------- | +| `send_private_msg` | 发送私聊消息 | ✔ | 不支持主动临时消息 | +| `send_group_msg` | 发送群消息 | ✔ | | +| `send_msg` | 发送消息 | ✔ | | +| `delete_msg` | 撤回消息 | ✔ | | +| `get_msg` | 获取消息 | ✔ | | +| `get_forward_msg` | 获取合并转发消息 | ✔ | | +| `send_like` | 发送好友赞 | ✔ | | +| `set_group_kick` | 群组踢人 | ✔ | | +| `set_group_ban` | 群组单人禁言 | ✔ | | +| `set_group_anonymous_ban` | 群组匿名用户禁言 | ❌ | 官方都没这功能了哦~ | +| `set_group_whole_ban` | 群组全员禁言 | ✔ | | +| `set_group_admin` | 群组设置管理员 | ✔ | | +| `set_group_anonymous` | 群组匿名 | ❌ | 官方都没这功能了哦~ | +| `set_group_card` | 设置群名片（群备注） | ✔ | | +| `set_group_name` | 设置群名 | ✔ | | +| `set_group_leave` | 退出群组 | ✔ | | +| `set_group_special_title` | 设置群组专属头衔 | ❌ | QQNT还没更新这个功能 | +| `set_friend_add_request` | 处理加好友请求 | ✔ | | +| `set_group_add_request` | 处理加群请求／邀请 | ✔ | | +| `get_login_info` | 获取登录号信息 | ✔ | | +| `get_stranger_info` | 获取陌生人信息 | ✔ | | +| `get_friend_list` | 获取好友列表 | ✔ | | +| `get_group_info` | 获取群信息 | ✔ | | +| `get_group_list` | 获取群列表 | ✔ | | +| `get_group_member_info` | 获取群成员信息 | ✔ | | +| `get_group_member_list` | 获取群成员列表 | ✔ | | +| `get_group_honor_info` | 获取群荣誉信息 | ✔ | | +| `get_cookies` | 获取 Cookies | ✔ | | +| `get_csrf_token` | 获取 CSRF Token | ❌ | | +| `get_credentials` | 获取 QQ 相关接口凭证 | ❌ | | +| `get_record` | 获取语音 | ✔ | | +| `get_image` | 获取图片 | ✔ | | +| `can_send_image` | 检查是否可以发送图片 | ✔ | | +| `can_send_record` | 检查是否可以发送语音 | ✔ | | +| `get_status` | 获取运行状态 | ✔ | | +| `get_version_info` | 获取版本信息 | ✔ | | +| `set_restart` | 重启 OneBot 实现 | ❌ | | +| `clean_cache` | 清理缓存 | ✔ | | + +## go-cqhttp API + +| Api | 介绍 | 可用 | 备注 | +| -------------------------------- | ------------------------------- | :---: | -------------------------------------- | +| `set_qq_profile` | 设置登录号资料 | ❌ | 使用 `set_self_profile` 代替 | +| `qidian_get_account_info` | 获取企点账号信息 | ❌ | 不支持企点哦~ | +| `_get_model_show` | 获取在线机型 | ❌ | QQNT还没更新这个功能 | +| `_set_model_show` | 设置在线机型 | ❌ | QQNT还没更新这个功能 | +| `get_online_clients` | 获取当前账号在线客户端列表 | ✔ | | +| `get_unidirectional_friend_list` | 获取单向好友列表 | ❌ | QQNT还没更新这个功能 | +| `delete_friend` | 删除好友 | ❌ | | +| `delete_unidirectional_friend` | 删除单向好友 | ❌ | QQNT还没更新这个功能 | +| `mark_msg_as_read` | 标记消息已读 | ✔ | | +| `send_group_forward_msg` | 发送合并转发 ( 群聊 ) | ✔ | | +| `send_private_forward_msg` | 发送合并转发 ( 好友 ) | ✔ | | +| `get_group_msg_history` | 获取群消息历史记录 | ✔ | | +| `ocr_image` | 图片 OCR | ✔ | | +| `get_group_system_msg` | 获取群系统消息 | ✔ | | +| `get_essence_msg_list` | 获取精华消息列表 | ✔ | | +| `get_group_at_all_remain` | 获取群 @全体成员 剩余次数 | ❌ | | +| `set_group_portrait` | 设置群头像 | ✔ | | +| `set_essence_msg` | 设置精华消息 | ✔ | | +| `delete_essence_msg` | 移出精华消息 | ✔ | | +| `send_group_sign` | 群打卡 | ❌ | 这个功能QQ也已经下线了哦~ | +| `_send_group_notice` | 发送群公告 | ✔ | | +| `_get_group_notice` | 获取群公告 | ✔ | | +| `upload_group_file` | 上传群文件 | ✔ | | +| `delete_group_file` | 删除群文件 | ❌ | 使用 `del_geoup_file` 代替 | +| `create_group_file_folder` | 创建群文件文件夹 | ❌ | 使用 `set_group_file_folder` 代替 | +| `delete_group_folder` | 删除群文件文件夹 | ❌ | 使用 `del_group_file_folder` 代替 | +| `get_group_file_system_info` | 获取群文件系统信息 | ❌ | 部分实现 见接口 `get_group_file_count` | +| `get_group_root_files` | 获取群根目录文件列表 | ❌ | 使用 `get_group_file_list` 代替 | +| `get_group_files_by_folder` | 获取群子目录文件列表 | ❌ | 使用 `get_group_file_list` 代替 | +| `get_group_file_url` | 获取群文件资源链接 | ❌ | NTQQ文件下载方式不同,请使用 `get_file` | +| `upload_private_file` | 上传私聊文件 | ✔ | | +| `reload_event_filter` | 重载事件过滤器 | ❌ | napcat没有事件过滤器哦~ | +| `download_file` | 下载文件到缓存目录 | ✔ | | +| `check_url_safely` | 检查链接安全性 | ❌ | | +| `.get_word_slices` | 获取中文分词 ( 隐藏 API ) | ❌ | | +| `.handle_quick_operation` | 对事件执行快速操作 ( 隐藏 API ) | ✔ | | + +## napcat API + +| Api | 介绍 | 可用 | 备注 | +| --------------------------- | ------------------ | :---: | ---- | +| `ArkShareGroup` | 推荐联系人/群聊 | ✔ | | +| `ArkSharePeer` | 推荐群聊 | ✔ | | +| `get_robot_uin_range` | 获取机器人QQ号区间 | ✔ | | +| `set_online_status` | 设置在线状态 | ✔ | | +| `get_friends_with_category` | 获取好友分类列表 | ✔ | | +| `set_qq_avatar` | 设置头像 | ✔ | | +| `get_file` | 获取文件信息 | ✔ | | +| `forward_friend_single_msg` | 转发单条信息到私聊 | ✔ | | +| `forward_group_single_msg` | 转发单条信息到群聊 | ✔ | | +| `translate_en2zh` | 英译中翻译 | ✔ | | +| `get_group_file_count` | 获取群文件数 | ✔ | | +| `get_group_file_list` | 获取群文件列表 | ✔ | | +| `set_group_file_folder` | 新建群文件文件夹 | ✔ | | +| `del_group_file` | 删除群文件文件 | ✔ | | +| `del_group_file_folder` | 删除群文件文件夹 | ✔ | | +| `set_msg_emoji_like` | 设置消息的表情回复 | ✔ | | +| `send_forward_msg` | 发送合并转发 | ✔ | | +| `mark_private_msg_as_read` | 标记私聊信息已读 | ✔ | | +| `mark_group_msg_as_read` | 标记群聊信息已读 | ✔ | | +| `get_friend_msg_history` | 获取私聊记录 | ✔ | | +| `set_self_profile` | 设置个人资料 | ✔ | | +| `create_collection` | 创建文本收藏 | ✔ | | +| `get_collection_list` | 获取收藏列表 | ✔ | | +| `set_self_longnick` | 设置个人签名 | ✔ | | +| `get_recent_contact` | 获取最近的聊天记录 | ✔ | | +| `_mark_all_as_read` | 标记所有为已读 | ✔ | | +| `get_profile_like` | 获取自身点赞列表 | ✔ | | +| `fetch_custom_face` | 获取收藏表情 | ✔ | | +| `fetch_emoji_like` | 拉取表情回应列表 | ✔ | | +| `set_input_status` | 设置输入状态 | ✔ | | +| `get_group_info_ex` | 获取群组额外信息 | ✔ | | diff --git a/docs/zh-CN/develop/event.md b/docs/zh-CN/develop/compatibility/event.md similarity index 98% rename from docs/zh-CN/develop/event.md rename to docs/zh-CN/develop/compatibility/event.md index 5bb499e..7557019 100644 --- a/docs/zh-CN/develop/event.md +++ b/docs/zh-CN/develop/compatibility/event.md @@ -1,4 +1,4 @@ -# 上报事件支持情况 +# 上报事件兼容情况 | 事件类型 | 可用 | 备注 | | -------------- | :---: | :---------------------: | diff --git a/docs/zh-CN/develop/msg.md b/docs/zh-CN/develop/compatibility/msg.md similarity index 93% rename from docs/zh-CN/develop/msg.md rename to docs/zh-CN/develop/compatibility/msg.md index 357951e..3930afd 100644 --- a/docs/zh-CN/develop/msg.md +++ b/docs/zh-CN/develop/compatibility/msg.md @@ -1,4 +1,4 @@ -# 消息格式支持情况 +# 消息格式兼容情况 | 消息格式 | 收 | 发 | 备注 | | ------------ | :---: | :---: | :----------------------------------------------------: | @@ -19,6 +19,6 @@ | 转发消息记录 | ✔ | ✔ | **不能伪造** | | 视频 | ✔ | ✔ | | | 文件 | ✔ | ✔ | 发送时可以指定`name`参数自定义文件名，详见扩展api | -| 音乐卡片 | ✔ | ✔ | QQ音乐传ID发送无须配置 其余需要配置签名服务器 | +| 音乐卡片 | ✔ | ✔ | QQ音乐传ID发送无须配置 其余需要配置签名服务器 | | 红包 | ❌ | ❌ | 没有计划支持 | | xml | ❌ | ❌ | 没有计划支持 | diff --git a/docs/zh-CN/guide/boot/only-gui/BootWay03.md b/docs/zh-CN/guide/boot/only-gui/BootWay03.md index 2b3fb1c..245436b 100644 --- a/docs/zh-CN/guide/boot/only-gui/BootWay03.md +++ b/docs/zh-CN/guide/boot/only-gui/BootWay03.md @@ -1,6 +1,6 @@ # BootWay03 撸猫教程（Only GUI） -首先，安装 QQ，确保你知道 QQ 的目录。Linux 一般在 `/opt/QQ`；Windows 一般在系统盘下 `Program Files\Tencent\QQNT`，具体定位方法可以参考 [BootWay05 教程](../shell/BootWay05.md)。 +首先，安装 QQ，确保你知道 QQ 的目录。Linux 一般在 `/opt/QQ`；Windows 一般在系统盘下 `Program Files\Tencent\QQNT`，具体定位方法可以参考 [BootWay05 教程](../shell/BootWay05.md)。 ## 预处理 @@ -31,7 +31,8 @@ require('./launcher.node').load('external_index', module); 在终端中启动 QQ，增加 `--enable-logging` 的 flag，这是为了方便获取控制台输出，以查看 NC 初始化状态和 WebUI 登入的凭据。 具体来说，可以启动一个工作目录在 NTQQ 的终端（参考 [BootWay05 教程](../shell/BootWay05.md)的手动安装部分），输入以下内容并回车： -```bash + +``` bash .\QQ.exe --enable-logging ``` diff --git a/docs/zh-CN/guide/boot/shell/BootWay03-Linux-SemiAuto.md b/docs/zh-CN/guide/boot/shell/BootWay03-Linux-SemiAuto.md index b991d75..b37599b 100644 --- a/docs/zh-CN/guide/boot/shell/BootWay03-Linux-SemiAuto.md +++ b/docs/zh-CN/guide/boot/shell/BootWay03-Linux-SemiAuto.md @@ -3,7 +3,8 @@ 手动安装 Linux QQ，并用你的包管理器安装以下包：`zip unzip jq curl xvfb screen`。 下载[最新 NapCat Release](https://github.com/NapNeko/NapCatQQ/releases) 中的 `NapCat.Shell.zip` 到用户目录某处（建议先切换到 `bash` 或者 `zsh`，不知道这是什么的就不用管了），然后复制以下内容，粘贴到终端里，然后按下 Enter 执行： -``` + +``` bash mkdir ./NapCat/ mkdir ./tmp/ unzip -q -o -d ./tmp NapCat.Shell.zip @@ -18,13 +19,13 @@ sudo bash -c "echo \"$output_index_js\" > \"$target_folder/index.js\"" 然后使用 -``` +``` bash xvfb-run -a qq --no-sandbox -q ``` 或者 -``` +``` bash xvfb-run -a linuxqq --no-sandbox -q ``` diff --git a/docs/zh-CN/guide/boot/shell/BootWay03.md b/docs/zh-CN/guide/boot/shell/BootWay03.md index c3344ad..0e60be6 100644 --- a/docs/zh-CN/guide/boot/shell/BootWay03.md +++ b/docs/zh-CN/guide/boot/shell/BootWay03.md @@ -1,6 +1,6 @@ # BootWay03 撸猫教程 -首先，安装 QQ，确保你知道 QQ 的目录。Linux 一般在 `/opt/QQ`；Windows 一般在系统盘下 `Program Files\Tencent\QQNT`，具体定位方法可以参考 [BootWay05 教程](BootWay05.md)。 +首先，安装 QQ，确保你知道 QQ 的目录。Linux 一般在 `/opt/QQ`；Windows 一般在系统盘下 `Program Files\Tencent\QQNT`，具体定位方法可以参考 [BootWay05 教程](BootWay05.md)。 ## 预处理 @@ -67,6 +67,7 @@ napcat-9912 为新的启动脚本，复制到任意位置双击打开即可快 在终端中启动 QQ，增加 `--enable-logging` 的 flag。 具体来说，可以启动一个工作目录在 NTQQ 的终端（参考 [BootWay05 教程](BootWay05.md)的手动安装部分），输入以下内容并回车： + ```bash .\QQ.exe --enable-logging ``` @@ -74,6 +75,7 @@ napcat-9912 为新的启动脚本，复制到任意位置双击打开即可快 ### Linux Linux QQ 在安装时即被加入 `PATH`，可以通过以下命令运行： + ```bash xvfb-run qq --no-sandbox -``` +``` diff --git a/docs/zh-CN/guide/boot/shell/BootWay05.md b/docs/zh-CN/guide/boot/shell/BootWay05.md index a8d3efb..c66627f 100644 --- a/docs/zh-CN/guide/boot/shell/BootWay05.md +++ b/docs/zh-CN/guide/boot/shell/BootWay05.md @@ -6,7 +6,7 @@ BootWay05 仅支持 Windows 64 位系统，需要确保你的电脑上安装 & ## 替换文件 -首先找到你下载的 NC 目录内的文件 `dbghelp.dll`： +首先找到你下载的 NC 目录内的文件 `dbghelp.dll`： ![alt text](../../../../asset/img/getting-started/nc051.png) 点击复制，完成后不要关闭文件管理窗口，否则会影响剪贴板。 @@ -22,9 +22,11 @@ BootWay05 仅支持 Windows 64 位系统，需要确保你的电脑上安装 & ## 首次启动 启动一个工作目录在 NC 目录的终端，输入 -``` + +``` bash powershell -ExecutionPolicy ByPass -File ./BootWay05.ps1 ``` + 并回车。 ## 再次启动 diff --git a/docs/zh-CN/guide/config/advanced.md b/docs/zh-CN/guide/config/advanced.md index 56ec487..ef15242 100644 --- a/docs/zh-CN/guide/config/advanced.md +++ b/docs/zh-CN/guide/config/advanced.md @@ -10,6 +10,7 @@ NapCat 本身并不直接提供HTTPS服务，但是你可通过其他WEB软件 > 首先我们假设你已经完成了域名绑定和SSL证书申请以及安装Nginx和NapCat的步骤，并且已经完成了NapCat的基础配置。 打开`./config/webui.json`文件： + - 将`host`修改为`127.0.0.1`。 - 将`prefix`修改为你喜好的符合URL编码规范的字符串，例如`/napcat`。 - `prefix`字段要求字符串以`/`开头但不以`/`结尾，所有不符合此规则的字符串都将被修正为符合规则的状态。 diff --git a/docs/zh-CN/guide/config/ffmpeg.md b/docs/zh-CN/guide/config/ffmpeg.md index 23fa0ec..642dd0a 100644 --- a/docs/zh-CN/guide/config/ffmpeg.md +++ b/docs/zh-CN/guide/config/ffmpeg.md @@ -53,3 +53,11 @@ 你可以使用 [Homebrew](https://brew.sh/) 安装 FFmpeg，也可以 [在此处](https://evermeet.cx/ffmpeg/) 手动下载二进制文件安装。 注意如果你选择手动安装，请确保你下载并安装了 [FFmpeg](https://evermeet.cx/ffmpeg/#:~:text=static%20%2D%2Ddisable%2Dffplay-,FFmpeg,-ffmpeg%2D114296%2Dg5ff0eb34d2)、[FFprobe](https://evermeet.cx/ffmpeg/#:~:text=external%20ffmpeg%20libraries-,FFprobe,-ffprobe%2D114296%2Dg5ff0eb34d2) 以及 [FFplay](https://evermeet.cx/ffmpeg/#:~:text=external%20ffprobe%20libraries-,FFplay,-ffplay%2D113169%2Dge1c1dc8347) 三个库，否则可能会产生意想不到的错误。 + +## 配置环境变量 + +将 ffmpeg 目录加入环境变量，如果仍未生效，可以修改 NapCat 启动脚本加入 FFMPEG_PATH 变量，指定到 ffmpeg 程序的完整路径。例如，Windows 上，可以修改 napcat.ps1，在第一行前加入 + +```powershell +$env:FFMPEG_PATH="d:\ffmpeg\bin\ffmpeg.exe" +``` diff --git a/docs/zh-CN/guide/faq.md b/docs/zh-CN/guide/faq.md index 581d92d..c9a4a9e 100644 --- a/docs/zh-CN/guide/faq.md +++ b/docs/zh-CN/guide/faq.md @@ -10,6 +10,8 @@ 将消息上报类型格式从消息段更改为 CQ 码即可。 +详见 [基础配置](./config/basic.md) 中的 `用文件配置 OneBot11 设置` + ::: ::: details 二维码无法扫描 @@ -24,13 +26,7 @@ NapCat 会自动保存二维码到目录，可以手动打开图片扫描。 ::: details 语音、视频发送失败 -这种情况需要你手动配置 ffmpeg 路径。ffmpeg 可以点击[这里](config/ffmpeg.md)下载。 - -将 ffmpeg 目录加入环境变量，如果仍未生效，可以修改 NapCat 启动脚本加入 FFMPEG_PATH 变量，指定到 ffmpeg 程序的完整路径。例如，Windows 上，可以修改 napcat.ps1，在第一行前加入 - -```powershell -$env:FFMPEG_PATH="d:\ffmpeg\bin\ffmpeg.exe" -``` +这种情况需要你手动配置 ffmpeg。如何配置详见[这里](config/ffmpeg.md)。 ::: diff --git a/docs/zh-CN/guide/getting-started.md b/docs/zh-CN/guide/getting-started.md index ae64085..0e3e24e 100644 --- a/docs/zh-CN/guide/getting-started.md +++ b/docs/zh-CN/guide/getting-started.md @@ -2,7 +2,7 @@ NapCatQQ V2 正式开始测试，欢迎来到 NapCatQQ (aka 猫猫框架) 的使用文档！ -## 开始之前 +## 使用之前 在开始使用之前，你需要了解以下内容。 @@ -12,34 +12,40 @@ NapCatQQ V2 正式开始测试，欢迎来到 NapCatQQ (aka 猫猫框架) 的使 ::: -现在，前往 [NapCatQQ 的 release 页面](https://github.com/NapNeko/NapCatQQ/releases)，各位可以看到有两个压缩包，文件名后缀分别为 `Shell` 和 `Framework`，应当如何选择呢？这就需要了解猫猫框架的启动方式了。 +## 如何使用 -1. 作为 [LiteLoaderQQNT](https://liteloaderqqnt.github.io/) 插件运行，类似 [LLOneBot](https://llonebot.github.io)，可以实现“人机合一”。 +前往 [NapCatQQ 的 release 页面](https://github.com/NapNeko/NapCatQQ/releases)，各位可以看到有两个压缩包， +文件名后缀分别为 `Shell` 和 `Framework`，应当如何选择呢？ +这就需要了解猫猫框架的启动方式了。 -2. 通过命令行启动，当你不需要或没有图形化界面，或者内存紧张，可以使用此方法。 +1. [方法 1](#方法1-作为-liteloader-插件启动) 作为 [LiteLoaderQQNT](https://liteloaderqqnt.github.io/) 插件运行，类似 [LLOneBot](https://llonebot.github.io)，可以实现“人机合一”。 -3. “Only GUI” 模式，当你不想使用 LiteLoader 插件时，却又想人机合一，又想折腾时，可以考虑此方法。 +2. [方法 2](#方法2-通过命令行启动) 通过命令行启动，当你不需要或没有图形化界面，或者内存紧张，可以使用此方法。 + +3. [方法 3](#方法3-only-gui) “Only GUI” 模式，当你不想使用 LiteLoader 插件时，却又想人机合一，又想折腾时，可以考虑此方法。 方法 1 和 3 都是“有头启动”，应当使用 Framework 版本；方法 2 是无头启动，应当使用 Shell 版本。我们目前对方法 1 和 2 有较为完整的文档支持，方法 3 还请自行探索。 请注意方法 1 和 3 “有头启动”仅在2.0.x 2.2.x 版本受到支持 2.1.x 1.x.x 版本均处于不可用状态 -## 作为 LiteLoader 插件启动 + +### 方法1: 作为 LiteLoader 插件启动 1. 按照 [LiteLoaderQQNT 官网](https://liteloaderqqnt.github.io/)的指导安装 LiteLoaderQQNT 框架。 2. 在 LiteLoaderQQNT 的设置页面（如下图）将 `NapCat.Framework.zip` 导入即可。 ![在这里](../../asset/img/getting-started/ll01.png) -## 通过命令行启动 +### 方法2: 通过命令行启动 -### 一键撸猫 +#### 一键撸猫 ::: details Windows x64 一键脚本 -``` +``` bash curl -o install.ps1 https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.ps1 powershell -ExecutionPolicy ByPass -File ./install.ps1 -verb runas ``` + 1. 点击复制上面代码，如下图。 ![复制代码](../../asset/img/getting-started/nc070.png) @@ -57,7 +63,11 @@ powershell -ExecutionPolicy ByPass -File ./install.ps1 -verb runas ::: ::: details Linux 一键脚本 (适用于 Ubuntu **20+** / Debian **10+** / CentOS **9**) -`curl -o napcat.sh https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.sh && sudo bash napcat.sh` + +``` bash +curl -o napcat.sh https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.sh && sudo bash napcat.sh +``` + ::: ::: details Linux 下使用 Docker @@ -69,15 +79,20 @@ powershell -ExecutionPolicy ByPass -File ./install.ps1 -verb runas ::: ::: details Termux 一键脚本 -`curl -o napcat.termux.sh https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.termux.sh && bash napcat.termux.sh` + +``` bash +curl -o napcat.termux.sh https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.termux.sh && bash napcat.termux.sh +``` + ::: ::: details 在 Railway 上部署 + [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/aRUNRZ?referralCode=Ns2Kracy) -::: +::: -### 手动/半自动撸猫 +#### 手动/半自动撸猫 目前已经研究完成并公布的启动方式有 BootWay03 和 05。 @@ -87,11 +102,11 @@ powershell -ExecutionPolicy ByPass -File ./install.ps1 -verb runas [前往了解 BootWay03 手动方案](./boot/shell/BootWay03)（适用于 Windows 和 Linux） -## Only GUI +### 方法3: Only GUI 目前该方案没有完整支持，仅有[手动方案](./boot/only-gui/BootWay03)，与上面的 BootWay03 类似。 -## 启动之后 +## 使用之后 恭喜你，如果看到这里，你已经成功启动了它，可以尝试阅读下面的进阶说明！ diff --git a/docs/zh-CN/guide/integration.md b/docs/zh-CN/guide/integration.md index e260640..9529bf4 100644 --- a/docs/zh-CN/guide/integration.md +++ b/docs/zh-CN/guide/integration.md @@ -45,6 +45,7 @@ 配置完成后，在 NapCat 的配置中添加 WS 反向地址。Koishi OneBot 的 ws 反向地址为 `ws://127.0.0.1:5140/onebot`。添加完成后，点击保存即可。 ::: + ## 配置 HTTP 服务 HTTP 服务的配置主要有两方面：一方面是 HTTP 监听端口（应当由你的应用端来调用），另一方面是 HTTP 上报地址（由 NapCat 来调用你的应用端）。 diff --git a/docs/zh-CN/guide/resource.md b/docs/zh-CN/guide/resource.md index 22f8209..33f155b 100644 --- a/docs/zh-CN/guide/resource.md +++ b/docs/zh-CN/guide/resource.md @@ -1,4 +1,5 @@ # 社区资源 + ::: details NC-nonebot平台更新工具 nonebot-plugin-ncupdate author: tianyisama @@ -15,4 +16,4 @@ author: huankong233 author: HeartfeltJoy [NapCat-Desktop](https://github.com/HeartfeltJoy/NapCatQQ-Desktop) -::: \ No newline at end of file +::: From 134c0401bb60f515005f095db2d6f1c15279e635 Mon Sep 17 00:00:00 2001 From: huankong233 Date: Fri, 30 Aug 2024 12:55:33 +0800 Subject: [PATCH 2/2] =?UTF-8?q?chore:=20docs=20-=20=E4=BF=AE=E6=94=B9?= =?UTF-8?q?=E4=BA=8B=E4=BB=B6=E7=9A=84=E5=85=BC=E5=AE=B9=E6=83=85=E5=86=B5?= =?UTF-8?q?=20-=20=E4=BF=AE=E6=94=B9=E6=B6=88=E6=81=AF=E6=A0=BC=E5=BC=8F?= =?UTF-8?q?=E7=9A=84=E5=85=BC=E5=AE=B9=E6=83=85=E5=86=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .markdownlint.json | 4 + docs/en-US/develop/api.md | 102 ++++++------- docs/en-US/develop/event.md | 36 ++--- docs/en-US/develop/msg.md | 36 ++--- docs/zh-CN/develop/compatibility/api.md | 170 +++++++++++----------- docs/zh-CN/develop/compatibility/event.md | 99 +++++++------ docs/zh-CN/develop/compatibility/msg.md | 53 ++++--- docs/zh-CN/guide/getting-started.md | 2 +- 8 files changed, 259 insertions(+), 243 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..aa4d7e2 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD024": false, + "MD013": false +} diff --git a/docs/en-US/develop/api.md b/docs/en-US/develop/api.md index 702b088..75e8e27 100644 --- a/docs/en-US/develop/api.md +++ b/docs/en-US/develop/api.md @@ -6,11 +6,11 @@ NapCatQQ implements most of the [OneBot 11](https://11.onebot.dev/) and [go-cqht | Connection Method | Available | | ---------------------- | :-------: | -| HTTP Interface Call | ✔ | -| HTTP POST Event Push | ✔ | -| HTTP POST Quick Action | ✔ | -| Forward WS Connection | ✔ | -| Reverse WS Connection | ✔ | +| HTTP Interface Call | ✅ | +| HTTP POST Event Push | ✅ | +| HTTP POST Quick Action | ✅ | +| Forward WS Connection | ✅ | +| Reverse WS Connection | ✅ | ## API Support @@ -18,44 +18,44 @@ NapCatQQ implements most of the [OneBot 11](https://11.onebot.dev/) and [go-cqht | Function | API | Available | Remarks | | ------------------------------ | ----------------------- | :-------: | ------------------------------ | -| Get bot account info | get_login_info | ✔ | | -| Send message | send_msg | ✔ | | -| Send group message | send_group_msg | ✔ | | -| Send private message | send_private_msg | ✔ | Does not support temp messages | -| Get message details | get_msg | ✔ | | -| Recall message | delete_msg | ✔ | | -| Like | send_like | ✔ | Supports liking group members | -| Get friend list | get_friend_list | ✔ | | -| Handle friend requests | set_friend_add_request | ✔ | | -| Get group list | get_group_list | ✔ | | -| Get group info | get_group_info | ✔ | | -| Get group member list | get_group_member_list | ✔ | | -| Get group member info | get_group_member_info | ✔ | | -| Get group honor info | get_group_honor_info | ✔ | | +| Get bot account info | get_login_info | ✅ | | +| Send message | send_msg | ✅ | | +| Send group message | send_group_msg | ✅ | | +| Send private message | send_private_msg | ✅ | Does not support temp messages | +| Get message details | get_msg | ✅ | | +| Recall message | delete_msg | ✅ | | +| Like | send_like | ✅ | Supports liking group members | +| Get friend list | get_friend_list | ✅ | | +| Handle friend requests | set_friend_add_request | ✅ | | +| Get group list | get_group_list | ✅ | | +| Get group info | get_group_info | ✅ | | +| Get group member list | get_group_member_list | ✅ | | +| Get group member info | get_group_member_info | ✅ | | +| Get group honor info | get_group_honor_info | ✅ | | | Set group exclusive title | set_group_special_title | ❌ | | | Group anonymous ban | set_group_anonymous_ban | ❌ | | | Toggle group anonymity | set_group_anonymous | ❌ | | -| Handle group join requests | set_group_add_request | ✔ | | -| Leave group | set_group_leave | ✔ | | -| Kick group members | set_group_kick | ✔ | | -| Group mute | set_group_ban | ✔ | | -| Group mute all | set_group_whole_ban | ✔ | | -| Set administrator | set_group_admin | ✔ | | -| Set group card | set_group_card | ✔ | | -| Set group name | set_group_name | ✔ | | -| Get stranger info | get_stranger_info | ✔ | Can only get group member info | -| Get version info | get_version_info | ✔ | | -| Get status | get_status | ✔ | | -| Check if can send image | can_send_image | ✔ | | -| Check if can send record | can_send_record | ✔ | | -| Get image details | get_image | ✔ | | -| Get record file | get_record | ✔ | | -| Get file details | get_file | ✔ | | -| Get Cookies | get_cookies | ✔ | | +| Handle group join requests | set_group_add_request | ✅ | | +| Leave group | set_group_leave | ✅ | | +| Kick group members | set_group_kick | ✅ | | +| Group mute | set_group_ban | ✅ | | +| Group mute all | set_group_whole_ban | ✅ | | +| Set administrator | set_group_admin | ✅ | | +| Set group card | set_group_card | ✅ | | +| Set group name | set_group_name | ✅ | | +| Get stranger info | get_stranger_info | ✅ | Can only get group member info | +| Get version info | get_version_info | ✅ | | +| Get status | get_status | ✅ | | +| Check if can send image | can_send_image | ✅ | | +| Check if can send record | can_send_record | ✅ | | +| Get image details | get_image | ✅ | | +| Get record file | get_record | ✅ | | +| Get file details | get_file | ✅ | | +| Get Cookies | get_cookies | ✅ | | | Get CSRF Token | get_csrf_token | ❌ | | | Get QQ-related API credentials | get_credentials | ❌ | | -| Restart OneBot implementation | set_restart | ✔ | | -| Clean cache | clean_cache | ✔ | | +| Restart OneBot implementation | set_restart | ✅ | | +| Clean cache | clean_cache | ✅ | | ::: @@ -63,18 +63,18 @@ NapCatQQ implements most of the [OneBot 11](https://11.onebot.dev/) and [go-cqht | API | Available | | ------------------------ | :-------: | -| send_forward_msg | ✔ | -| send_private_forward_msg | ✔ | -| send_group_forward_msg | ✔ | -| get_forward_msg | ✔ | -| upload_group_file | ✔ | -| download_file | ✔ | -| _get_group_notice | ✔ | -| get_essence_msg_list | ✔ | -| _send_group_notice | ✔ | -| _get_group_notice | ✔ | -| get_group_system_msg | ✔ | -| ocr_image | ✔ | -| get_online_clients | ✔ | +| send_forward_msg | ✅ | +| send_private_forward_msg | ✅ | +| send_group_forward_msg | ✅ | +| get_forward_msg | ✅ | +| upload_group_file | ✅ | +| download_file | ✅ | +| _get_group_notice | ✅ | +| get_essence_msg_list | ✅ | +| _send_group_notice | ✅ | +| _get_group_notice | ✅ | +| get_group_system_msg | ✅ | +| ocr_image | ✅ | +| get_online_clients | ✅ | ::: diff --git a/docs/en-US/develop/event.md b/docs/en-US/develop/event.md index 00b5359..f3367d6 100644 --- a/docs/en-US/develop/event.md +++ b/docs/en-US/develop/event.md @@ -2,26 +2,26 @@ | Event Type | Available | Note | | ---------------------------- | :-------: | :------------------------------------: | -| Message | ✔ | | -| Reaction | ✔ | | -| Friend Message Recall | ✔ | | -| Group Message Recall | ✔ | | -| Friend Request | ✔ | | -| Group Invite Request | ✔ | | -| Group Join Request | ✔ | Requires admin permissions | -| Management Change | ✔ | Requires admin permissions | -| Group Member Addition | ✔ | | -| Group Member Removal | ✔ | | -| Group File Upload | ✔ | | -| Group Mute | ✔ | | -| Group Member Nickname Change | ✔ | | -| Group Member Title Change | ✔ | | -| Poke in Group | ✔ | ID not available will be reported as 0 | -| Poke a Friend | ✔ | | +| Message | ✅ | | +| Reaction | ✅ | | +| Friend Message Recall | ✅ | | +| Group Message Recall | ✅ | | +| Friend Request | ✅ | | +| Group Invite Request | ✅ | | +| Group Join Request | ✅ | Requires admin permissions | +| Management Change | ✅ | Requires admin permissions | +| Group Member Addition | ✅ | | +| Group Member Removal | ✅ | | +| Group File Upload | ✅ | | +| Group Mute | ✅ | | +| Group Member Nickname Change | ✅ | | +| Group Member Title Change | ✅ | | +| Poke in Group | ✅ | ID not available will be reported as 0 | +| Poke a Friend | ✅ | | | Group Red Packet Luck King | ❌ | | | Group Member Honor Change | ❌ | | -| Lifecycle | ✔ | Currently only ws connect available | -| ws Heartbeat | ✔ | | +| Lifecycle | ✅ | Currently only ws connect available | +| ws Heartbeat | ✅ | | ## Reaction Reporting diff --git a/docs/en-US/develop/msg.md b/docs/en-US/develop/msg.md index f2a135f..97a5f3f 100644 --- a/docs/en-US/develop/msg.md +++ b/docs/en-US/develop/msg.md @@ -2,23 +2,23 @@ | Message Format | Receive | Send | Remarks | | ------------------------- | :-----: | :---: | :-----------------------------------------------------------------: | -| CQ Code | ✔ | ✔ | | -| Text | ✔ | ✔ | | -| Emoji | ✔ | ✔ | | -| Rock-Paper-Scissors Emoji | ✔ | ✔ | | -| Dice Emoji | ✔ | ✔ | | -| Store Emoji | ✔ | ✔ | | -| Markdown | ✔ | ❌ | {type: "markdown", data: {data: "`**Markdown content**`"}} | -| Image | ✔ | ✔ | | -| Poke a Friend | ✔ | ❌ | | -| Poke in Group | ✔ | ❌ | | -| Quote Message | ✔ | ✔ | | -| @Group Members | ✔ | ✔ | | -| Voice Message | ✔ | ✔ | Supports various audio formats like mp3, wav for direct sending | -| JSON Message | ✔ | ✔ | Sending requires manually signed token | -| Forwarded Message Record | ✔ | ✔ | **Cannot be forged** | -| Video | ✔ | ✔ | | -| File | ✔ | ✔ | Can specify `name` parameter for custom file name, see extended API | -| Music Card | ✔ | ✔ | Requires configuration of signature server | +| CQ Code | ✅ | ✅ | | +| Text | ✅ | ✅ | | +| Emoji | ✅ | ✅ | | +| Rock-Paper-Scissors Emoji | ✅ | ✅ | | +| Dice Emoji | ✅ | ✅ | | +| Store Emoji | ✅ | ✅ | | +| Markdown | ✅ | ❌ | {type: "markdown", data: {data: "`**Markdown content**`"}} | +| Image | ✅ | ✅ | | +| Poke a Friend | ✅ | ❌ | | +| Poke in Group | ✅ | ❌ | | +| Quote Message | ✅ | ✅ | | +| @Group Members | ✅ | ✅ | | +| Voice Message | ✅ | ✅ | Supports various audio formats like mp3, wav for direct sending | +| JSON Message | ✅ | ✅ | Sending requires manually signed token | +| Forwarded Message Record | ✅ | ✅ | **Cannot be forged** | +| Video | ✅ | ✅ | | +| File | ✅ | ✅ | Can specify `name` parameter for custom file name, see extended API | +| Music Card | ✅ | ✅ | Requires configuration of signature server | | Red Packet | ❌ | ❌ | No plans to support | | XML | ❌ | ❌ | No plans to support | diff --git a/docs/zh-CN/develop/compatibility/api.md b/docs/zh-CN/develop/compatibility/api.md index 0e76600..a332c34 100644 --- a/docs/zh-CN/develop/compatibility/api.md +++ b/docs/zh-CN/develop/compatibility/api.md @@ -6,54 +6,54 @@ NapCatQQ 实现了 [OneBot 11](https://11.onebot.dev/) 以及 [go-cqhttp](https: | 连接方式 | 可用 | | ------------------ | :---: | -| HTTP 接口调用 | ✔ | -| HTTP POST 事件上报 | ✔ | -| HTTP POST 快速操作 | ✔ | -| 正向 WS 连接 | ✔ | -| 反向 WS 连接 | ✔ | +| HTTP 接口调用 | ✅ | +| HTTP POST 事件上报 | ✅ | +| HTTP POST 快速操作 | ✅ | +| 正向 WS 连接 | ✅ | +| 反向 WS 连接 | ✅ | ## OneBot 11 API | Api | 介绍 | 可用 | 备注 | | ------------------------- | -------------------- | :---: | -------------------- | -| `send_private_msg` | 发送私聊消息 | ✔ | 不支持主动临时消息 | -| `send_group_msg` | 发送群消息 | ✔ | | -| `send_msg` | 发送消息 | ✔ | | -| `delete_msg` | 撤回消息 | ✔ | | -| `get_msg` | 获取消息 | ✔ | | -| `get_forward_msg` | 获取合并转发消息 | ✔ | | -| `send_like` | 发送好友赞 | ✔ | | -| `set_group_kick` | 群组踢人 | ✔ | | -| `set_group_ban` | 群组单人禁言 | ✔ | | +| `send_private_msg` | 发送私聊消息 | ✅ | 不支持主动临时消息 | +| `send_group_msg` | 发送群消息 | ✅ | | +| `send_msg` | 发送消息 | ✅ | | +| `delete_msg` | 撤回消息 | ✅ | | +| `get_msg` | 获取消息 | ✅ | | +| `get_forward_msg` | 获取合并转发消息 | ✅ | | +| `send_like` | 发送好友赞 | ✅ | | +| `set_group_kick` | 群组踢人 | ✅ | | +| `set_group_ban` | 群组单人禁言 | ✅ | | | `set_group_anonymous_ban` | 群组匿名用户禁言 | ❌ | 官方都没这功能了哦~ | -| `set_group_whole_ban` | 群组全员禁言 | ✔ | | -| `set_group_admin` | 群组设置管理员 | ✔ | | +| `set_group_whole_ban` | 群组全员禁言 | ✅ | | +| `set_group_admin` | 群组设置管理员 | ✅ | | | `set_group_anonymous` | 群组匿名 | ❌ | 官方都没这功能了哦~ | -| `set_group_card` | 设置群名片（群备注） | ✔ | | -| `set_group_name` | 设置群名 | ✔ | | -| `set_group_leave` | 退出群组 | ✔ | | +| `set_group_card` | 设置群名片（群备注） | ✅ | | +| `set_group_name` | 设置群名 | ✅ | | +| `set_group_leave` | 退出群组 | ✅ | | | `set_group_special_title` | 设置群组专属头衔 | ❌ | QQNT还没更新这个功能 | -| `set_friend_add_request` | 处理加好友请求 | ✔ | | -| `set_group_add_request` | 处理加群请求／邀请 | ✔ | | -| `get_login_info` | 获取登录号信息 | ✔ | | -| `get_stranger_info` | 获取陌生人信息 | ✔ | | -| `get_friend_list` | 获取好友列表 | ✔ | | -| `get_group_info` | 获取群信息 | ✔ | | -| `get_group_list` | 获取群列表 | ✔ | | -| `get_group_member_info` | 获取群成员信息 | ✔ | | -| `get_group_member_list` | 获取群成员列表 | ✔ | | -| `get_group_honor_info` | 获取群荣誉信息 | ✔ | | -| `get_cookies` | 获取 Cookies | ✔ | | +| `set_friend_add_request` | 处理加好友请求 | ✅ | | +| `set_group_add_request` | 处理加群请求／邀请 | ✅ | | +| `get_login_info` | 获取登录号信息 | ✅ | | +| `get_stranger_info` | 获取陌生人信息 | ✅ | | +| `get_friend_list` | 获取好友列表 | ✅ | | +| `get_group_info` | 获取群信息 | ✅ | | +| `get_group_list` | 获取群列表 | ✅ | | +| `get_group_member_info` | 获取群成员信息 | ✅ | | +| `get_group_member_list` | 获取群成员列表 | ✅ | | +| `get_group_honor_info` | 获取群荣誉信息 | ✅ | | +| `get_cookies` | 获取 Cookies | ✅ | | | `get_csrf_token` | 获取 CSRF Token | ❌ | | | `get_credentials` | 获取 QQ 相关接口凭证 | ❌ | | -| `get_record` | 获取语音 | ✔ | | -| `get_image` | 获取图片 | ✔ | | -| `can_send_image` | 检查是否可以发送图片 | ✔ | | -| `can_send_record` | 检查是否可以发送语音 | ✔ | | -| `get_status` | 获取运行状态 | ✔ | | -| `get_version_info` | 获取版本信息 | ✔ | | +| `get_record` | 获取语音 | ✅ | | +| `get_image` | 获取图片 | ✅ | | +| `can_send_image` | 检查是否可以发送图片 | ✅ | | +| `can_send_record` | 检查是否可以发送语音 | ✅ | | +| `get_status` | 获取运行状态 | ✅ | | +| `get_version_info` | 获取版本信息 | ✅ | | | `set_restart` | 重启 OneBot 实现 | ❌ | | -| `clean_cache` | 清理缓存 | ✔ | | +| `clean_cache` | 清理缓存 | ✅ | | ## go-cqhttp API @@ -63,25 +63,25 @@ NapCatQQ 实现了 [OneBot 11](https://11.onebot.dev/) 以及 [go-cqhttp](https: | `qidian_get_account_info` | 获取企点账号信息 | ❌ | 不支持企点哦~ | | `_get_model_show` | 获取在线机型 | ❌ | QQNT还没更新这个功能 | | `_set_model_show` | 设置在线机型 | ❌ | QQNT还没更新这个功能 | -| `get_online_clients` | 获取当前账号在线客户端列表 | ✔ | | +| `get_online_clients` | 获取当前账号在线客户端列表 | ✅ | | | `get_unidirectional_friend_list` | 获取单向好友列表 | ❌ | QQNT还没更新这个功能 | | `delete_friend` | 删除好友 | ❌ | | | `delete_unidirectional_friend` | 删除单向好友 | ❌ | QQNT还没更新这个功能 | -| `mark_msg_as_read` | 标记消息已读 | ✔ | | -| `send_group_forward_msg` | 发送合并转发 ( 群聊 ) | ✔ | | -| `send_private_forward_msg` | 发送合并转发 ( 好友 ) | ✔ | | -| `get_group_msg_history` | 获取群消息历史记录 | ✔ | | -| `ocr_image` | 图片 OCR | ✔ | | -| `get_group_system_msg` | 获取群系统消息 | ✔ | | -| `get_essence_msg_list` | 获取精华消息列表 | ✔ | | +| `mark_msg_as_read` | 标记消息已读 | ✅ | | +| `send_group_forward_msg` | 发送合并转发 ( 群聊 ) | ✅ | | +| `send_private_forward_msg` | 发送合并转发 ( 好友 ) | ✅ | | +| `get_group_msg_history` | 获取群消息历史记录 | ✅ | | +| `ocr_image` | 图片 OCR | ✅ | | +| `get_group_system_msg` | 获取群系统消息 | ✅ | | +| `get_essence_msg_list` | 获取精华消息列表 | ✅ | | | `get_group_at_all_remain` | 获取群 @全体成员 剩余次数 | ❌ | | -| `set_group_portrait` | 设置群头像 | ✔ | | -| `set_essence_msg` | 设置精华消息 | ✔ | | -| `delete_essence_msg` | 移出精华消息 | ✔ | | +| `set_group_portrait` | 设置群头像 | ✅ | | +| `set_essence_msg` | 设置精华消息 | ✅ | | +| `delete_essence_msg` | 移出精华消息 | ✅ | | | `send_group_sign` | 群打卡 | ❌ | 这个功能QQ也已经下线了哦~ | -| `_send_group_notice` | 发送群公告 | ✔ | | -| `_get_group_notice` | 获取群公告 | ✔ | | -| `upload_group_file` | 上传群文件 | ✔ | | +| `_send_group_notice` | 发送群公告 | ✅ | | +| `_get_group_notice` | 获取群公告 | ✅ | | +| `upload_group_file` | 上传群文件 | ✅ | | | `delete_group_file` | 删除群文件 | ❌ | 使用 `del_geoup_file` 代替 | | `create_group_file_folder` | 创建群文件文件夹 | ❌ | 使用 `set_group_file_folder` 代替 | | `delete_group_folder` | 删除群文件文件夹 | ❌ | 使用 `del_group_file_folder` 代替 | @@ -89,45 +89,45 @@ NapCatQQ 实现了 [OneBot 11](https://11.onebot.dev/) 以及 [go-cqhttp](https: | `get_group_root_files` | 获取群根目录文件列表 | ❌ | 使用 `get_group_file_list` 代替 | | `get_group_files_by_folder` | 获取群子目录文件列表 | ❌ | 使用 `get_group_file_list` 代替 | | `get_group_file_url` | 获取群文件资源链接 | ❌ | NTQQ文件下载方式不同,请使用 `get_file` | -| `upload_private_file` | 上传私聊文件 | ✔ | | +| `upload_private_file` | 上传私聊文件 | ✅ | | | `reload_event_filter` | 重载事件过滤器 | ❌ | napcat没有事件过滤器哦~ | -| `download_file` | 下载文件到缓存目录 | ✔ | | +| `download_file` | 下载文件到缓存目录 | ✅ | | | `check_url_safely` | 检查链接安全性 | ❌ | | | `.get_word_slices` | 获取中文分词 ( 隐藏 API ) | ❌ | | -| `.handle_quick_operation` | 对事件执行快速操作 ( 隐藏 API ) | ✔ | | +| `.handle_quick_operation` | 对事件执行快速操作 ( 隐藏 API ) | ✅ | | ## napcat API | Api | 介绍 | 可用 | 备注 | | --------------------------- | ------------------ | :---: | ---- | -| `ArkShareGroup` | 推荐联系人/群聊 | ✔ | | -| `ArkSharePeer` | 推荐群聊 | ✔ | | -| `get_robot_uin_range` | 获取机器人QQ号区间 | ✔ | | -| `set_online_status` | 设置在线状态 | ✔ | | -| `get_friends_with_category` | 获取好友分类列表 | ✔ | | -| `set_qq_avatar` | 设置头像 | ✔ | | -| `get_file` | 获取文件信息 | ✔ | | -| `forward_friend_single_msg` | 转发单条信息到私聊 | ✔ | | -| `forward_group_single_msg` | 转发单条信息到群聊 | ✔ | | -| `translate_en2zh` | 英译中翻译 | ✔ | | -| `get_group_file_count` | 获取群文件数 | ✔ | | -| `get_group_file_list` | 获取群文件列表 | ✔ | | -| `set_group_file_folder` | 新建群文件文件夹 | ✔ | | -| `del_group_file` | 删除群文件文件 | ✔ | | -| `del_group_file_folder` | 删除群文件文件夹 | ✔ | | -| `set_msg_emoji_like` | 设置消息的表情回复 | ✔ | | -| `send_forward_msg` | 发送合并转发 | ✔ | | -| `mark_private_msg_as_read` | 标记私聊信息已读 | ✔ | | -| `mark_group_msg_as_read` | 标记群聊信息已读 | ✔ | | -| `get_friend_msg_history` | 获取私聊记录 | ✔ | | -| `set_self_profile` | 设置个人资料 | ✔ | | -| `create_collection` | 创建文本收藏 | ✔ | | -| `get_collection_list` | 获取收藏列表 | ✔ | | -| `set_self_longnick` | 设置个人签名 | ✔ | | -| `get_recent_contact` | 获取最近的聊天记录 | ✔ | | -| `_mark_all_as_read` | 标记所有为已读 | ✔ | | -| `get_profile_like` | 获取自身点赞列表 | ✔ | | -| `fetch_custom_face` | 获取收藏表情 | ✔ | | -| `fetch_emoji_like` | 拉取表情回应列表 | ✔ | | -| `set_input_status` | 设置输入状态 | ✔ | | -| `get_group_info_ex` | 获取群组额外信息 | ✔ | | +| `ArkShareGroup` | 推荐联系人/群聊 | ✅ | | +| `ArkSharePeer` | 推荐群聊 | ✅ | | +| `get_robot_uin_range` | 获取机器人QQ号区间 | ✅ | | +| `set_online_status` | 设置在线状态 | ✅ | | +| `get_friends_with_category` | 获取好友分类列表 | ✅ | | +| `set_qq_avatar` | 设置头像 | ✅ | | +| `get_file` | 获取文件信息 | ✅ | | +| `forward_friend_single_msg` | 转发单条信息到私聊 | ✅ | | +| `forward_group_single_msg` | 转发单条信息到群聊 | ✅ | | +| `translate_en2zh` | 英译中翻译 | ✅ | | +| `get_group_file_count` | 获取群文件数 | ✅ | | +| `get_group_file_list` | 获取群文件列表 | ✅ | | +| `set_group_file_folder` | 新建群文件文件夹 | ✅ | | +| `del_group_file` | 删除群文件文件 | ✅ | | +| `del_group_file_folder` | 删除群文件文件夹 | ✅ | | +| `set_msg_emoji_like` | 设置消息的表情回复 | ✅ | | +| `send_forward_msg` | 发送合并转发 | ✅ | | +| `mark_private_msg_as_read` | 标记私聊信息已读 | ✅ | | +| `mark_group_msg_as_read` | 标记群聊信息已读 | ✅ | | +| `get_friend_msg_history` | 获取私聊记录 | ✅ | | +| `set_self_profile` | 设置个人资料 | ✅ | | +| `create_collection` | 创建文本收藏 | ✅ | | +| `get_collection_list` | 获取收藏列表 | ✅ | | +| `set_self_longnick` | 设置个人签名 | ✅ | | +| `get_recent_contact` | 获取最近的聊天记录 | ✅ | | +| `_mark_all_as_read` | 标记所有为已读 | ✅ | | +| `get_profile_like` | 获取自身点赞列表 | ✅ | | +| `fetch_custom_face` | 获取收藏表情 | ✅ | | +| `fetch_emoji_like` | 拉取表情回应列表 | ✅ | | +| `set_input_status` | 设置输入状态 | ✅ | | +| `get_group_info_ex` | 获取群组额外信息 | ✅ | | diff --git a/docs/zh-CN/develop/compatibility/event.md b/docs/zh-CN/develop/compatibility/event.md index 7557019..25e8faa 100644 --- a/docs/zh-CN/develop/compatibility/event.md +++ b/docs/zh-CN/develop/compatibility/event.md @@ -1,50 +1,53 @@ # 上报事件兼容情况 -| 事件类型 | 可用 | 备注 | -| -------------- | :---: | :---------------------: | -| 消息 | ✔ | | -| 表情回应 | ✔ | | -| 好友消息撤回 | ✔ | | -| 群消息撤回 | ✔ | | -| 好友请求 | ✔ | | -| 邀请加群请求 | ✔ | | -| 加群请求 | ✔ | 需要管理员权限 | -| 管理变动 | ✔ | 需要管理员权限 | -| 群成员增加 | ✔ | | -| 群成员减少 | ✔ | | -| 群文件上传 | ✔ | | -| 群禁言 | ✔ | | -| 群成员名片变更 | ✔ | | -| 群成员头衔变更 | ✔ | | -| 群内戳一戳 | ✔ | 无法获取操作ID将上报为0 | -| 好友戳一戳 | ✔ | | -| 群红包运气王 | ❌ | | -| 群成员荣誉变更 | ❌ | | -| 生命周期 | ✔ | 目前只有 ws 的 connect | -| ws心跳 | ✔ | | - -## 表情回应上报 - -```json5 -{ - "time": 1714491493, - "self_id": 123456, - "post_type": "notice", - "group_id": 12312312, - "user_id": 1231312, - "notice_type": "group_msg_emoji_like", - "message_id": -2147476175, - "likes": [ - { - "emoji_id": "76", - "count": 1 - } - ] -} -``` - -emoji_id 参考 - -## 表情回应发送 - -参考 [扩展 API](./extends_api.md) +## meta_event 事件 + +| 事件名 | 说明 | 可用 | 备注 | +| ---------------------- | -------- | :---: | ---- | +| `meta_event.lifecycle` | 生命周期 | ✅ | | +| `meta_event.heartbeat` | 心跳 | ✅ | | + +### message 事件 + +| 事件名 | 说明 | 可用 | 备注 | +| ----------------- | -------- | :---: | ---- | +| `message.private` | 私聊消息 | ✅ | | +| `message.group` | 群聊消息 | ✅ | | + +### message_sent 事件 + +| 事件名 | 说明 | 可用 | 备注 | +| ---------------------- | -------- | :---: | ---- | +| `message_sent.private` | 私聊消息 | ✅ | | +| `message_sent.group` | 群聊消息 | ✅ | | + +### request 事件 + +| 事件名 | 说明 | 可用 | 备注 | +| ---------------------- | -------------- | :---: | -------------- | +| `request.friend` | 加好友请求 | ✅ | | +| `request.group.add` | 加群请求 | ✅ | 需要管理员权限 | +| `request.group.invite` | 邀请登录号入群 | ✅ | | + +### notice 事件 + +| 事件名 | 说明 | 可用 | 备注 | +| ----------------------------- | ---------------------- | :---: | ----------------------- | +| `notice.friend_recall` | 私聊消息撤回 | ✅ | | +| `notice.group_recall` | 群聊消息撤回 | ✅ | | +| `notice.group_increase` | 群聊成员增加 | ✅ | | +| `notice.group_decrease` | 群聊成员减少 | ✅ | | +| `notice.group_admin` | 群聊管理员变动 | ❌ | 需要管理员权限 | +| `notice.group_upload` | 群聊文件上传 | ✅ | | +| `notice.group_ban` | 群聊禁言 | ✅ | | +| `notice.friend_add` | 好友添加 | ✅ | | +| `notice.notify.poke` | 戳一戳 | ✅ | 无法获取操作ID将上报为0 | +| `notice.notify.lucky_king` | 群红包运气王提示 | ❌ | | +| `notice.notify.honor` | 群成员荣誉变更 | ❌ | | +| `notice.notify.title` | 群成员头衔变更 | ❌ | | +| `notice.notify.input_status` | 输入状态更新 | ✅ | | +| `notice.group_card` | 群成员名片更新 | ❌ | | +| `notice.offline_file` | 接收到离线文件 | ❌ | | +| `notice.client_status` | 其他客户端在线状态变更 | ❌ | | +| `notice.essence` | 群聊设精(设置精华) | ⏹ | 可以收到添加收不到取消 | +| `notice.group_msg_emoji_like` | 群聊表情回应 | ✅ | | diff --git a/docs/zh-CN/develop/compatibility/msg.md b/docs/zh-CN/develop/compatibility/msg.md index 3930afd..bb94a97 100644 --- a/docs/zh-CN/develop/compatibility/msg.md +++ b/docs/zh-CN/develop/compatibility/msg.md @@ -1,24 +1,33 @@ # 消息格式兼容情况 -| 消息格式 | 收 | 发 | 备注 | -| ------------ | :---: | :---: | :----------------------------------------------------: | -| cq码 | ✔ | ✔ | | -| 文字 | ✔ | ✔ | | -| 表情 | ✔ | ✔ | | -| 猜拳魔法表情 | ✔ | ✔ | | -| 骰子魔法表情 | ✔ | ✔ | | -| 商城表情 | ✔ | ✔ | | -| markdown | ✔ | ❌ | {type: "markdown", data: {data: "`**markdown内容**`"}} | -| 图片 | ✔ | ✔ | | -| 好友戳一戳 | ✔ | ❌ | | -| 群戳一戳 | ✔ | ❌ | | -| 引用消息 | ✔ | ✔ | | -| @群成员 | ✔ | ✔ | | -| 语音 | ✔ | ✔ | 支持mp3、wav等多种音频格式直接发送 | -| json消息 | ✔ | ✔ | 发送需要自行签名token | -| 转发消息记录 | ✔ | ✔ | **不能伪造** | -| 视频 | ✔ | ✔ | | -| 文件 | ✔ | ✔ | 发送时可以指定`name`参数自定义文件名，详见扩展api | -| 音乐卡片 | ✔ | ✔ | QQ音乐传ID发送无须配置 其余需要配置签名服务器 | -| 红包 | ❌ | ❌ | 没有计划支持 | -| xml | ❌ | ❌ | 没有计划支持 | +支持使用 `CQ码` 发送 + +| 消息格式 | 介绍 | 收 | 发 | 备注 | +| ----------- | ------------------- | :---: | :---: | :---------------------------------------------------------------: | +| `text` | 纯文本 | ✅ | ✅ | | +| `at` | @某人 | ✅ | ✅ | | +| `reply` | 回复消息 | ✅ | ✅ | | +| `face` | `qq` 表情 | ✅ | ✅ | | +| `mface` | `qq` 表情包 | ✅ | ✅ | | +| `image` | 图片 | ✅ | ✅ | | +| `file` | 文件 | ✅ | ✅ | 发送时可以指定`name`参数自定义文件名 | +| `video` | 视频 | ✅ | ✅ | | +| `record` | 语音 | ✅ | ✅ | | +| `json` | `json` 信息 | ✅ | ✅ | 发送需要自行签名token | +| `dice` | 骰子 | ✅ | ✅ | | +| `rps` | 猜拳 | ✅ | ✅ | | +| `music` | 音乐分享 | ❌ | ✅ | QQ音乐传ID发送无须配置 其余需要配置签名服务器,收到的时候是 `json` | +| `node` | 转发消息节点 | ❌ | ✅ | | +| `forward` | 转发消息 | ✅ | ❌ | **不能伪造** | +| `markdown` | `markdown` | ✅ | ❌ | | +| `shake` | 私聊窗口抖动/戳一戳 | ✅ | ❌ | | +| `poke` | 群聊戳一戳 | ✅ | ❌ | | +| `share` | 链接分享 | ✅ | ❌ | 收到的时候是 `json` | +| `contact` | 推荐好友/群 | ✅ | ❌ | 发送可以使用接口 `ArkShareGroup`,收到的时候是 `json` | +| `location` | 位置 | ✅ | ❌ | 收到的时候是 `json` | +| `gift` | 礼物 | ✅ | ❌ | 收到的时候是 `json` | +| `anonymous` | 匿名发消息 | ❌ | ❌ | 已经没有匿名了哦~ | +| `redbag` | `红包` | ❌ | ❌ | 没有计划支持 | +| `xml` | `xml` | ❌ | ❌ | 没有计划支持 | +| `cardimage` | `cardimage` | ❌ | ❌ | 没有计划支持 | +| `tts` | `tts` | ❌ | ❌ | 没有计划支持 | diff --git a/docs/zh-CN/guide/getting-started.md b/docs/zh-CN/guide/getting-started.md index 0e3e24e..50b31d2 100644 --- a/docs/zh-CN/guide/getting-started.md +++ b/docs/zh-CN/guide/getting-started.md @@ -30,7 +30,7 @@ NapCatQQ V2 正式开始测试，欢迎来到 NapCatQQ (aka 猫猫框架) 的使 ### 方法1: 作为 LiteLoader 插件启动 -1. 按照 [LiteLoaderQQNT 官网](https://liteloaderqqnt.github.io/)的指导安装 LiteLoaderQQNT 框架。 +1. 按照 [LiteLoaderQQNT 官网](https://liteloaderqqnt.github.io/) 的指导安装 LiteLoaderQQNT 框架。 2. 在 LiteLoaderQQNT 的设置页面（如下图）将 `NapCat.Framework.zip` 导入即可。 ![在这里](../../asset/img/getting-started/ll01.png)