From 98c2f95e089c1aade271456359ef74b329d4590f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=87=89=E8=8F=9C?= <1659488338@qq.com> Date: Fri, 5 Jul 2024 09:14:51 +0800 Subject: [PATCH] fix: rename and transfer --- .github/workflows/release.yaml | 2 +- CHANGELOG.md | 236 ++++++++++++++++----------------- README.md | 8 +- docs/.vitepress/config.mts | 10 +- docs/src/guide/instruction.md | 12 +- docs/src/guide/start.md | 10 +- docs/src/index.md | 4 +- docs/src/segment/index.md | 4 +- package-lock.json | 4 +- package.json | 6 +- 10 files changed, 148 insertions(+), 148 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 9d35047..c32d948 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -14,7 +14,7 @@ jobs: id: release with: release-type: node - package-name: qq-group-bot + package-name: qq-official-bot # Checkout - uses: actions/checkout@v4 if: ${{ steps.release.outputs.release_created }} diff --git a/CHANGELOG.md b/CHANGELOG.md index bb7edb6..20b5188 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,341 +8,341 @@ * change reactionGuildMessage to addGuildMessageReaction ([8ffbdc4](https://github.com/lc-cn/qq-group-bot/commit/8ffbdc41ade6fdb309c569df494a82c824f5fa31)) * 支持频道消息表态添加删除事件 ([0d8aabd](https://github.com/lc-cn/qq-group-bot/commit/0d8aabdf12c5b161fa7b7f4b3a1fafb6d7b0fbf8)) -## [1.1.0](https://github.com/lc-cn/qq-group-bot/compare/v1.0.42...v1.1.0) (2024-05-31) +## [1.1.0](https://github.com/lc-cn/qq-official-bot/compare/v1.0.42...v1.1.0) (2024-05-31) ### Features -* reply event_id ([e3d02cc](https://github.com/lc-cn/qq-group-bot/commit/e3d02cc0d4314b51b54e655c2c7f3a1f09629719)) +* reply event_id ([e3d02cc](https://github.com/lc-cn/qq-official-bot/commit/e3d02cc0d4314b51b54e655c2c7f3a1f09629719)) -## [1.0.42](https://github.com/lc-cn/qq-group-bot/compare/v1.0.41...v1.0.42) (2024-03-26) +## [1.0.42](https://github.com/lc-cn/qq-official-bot/compare/v1.0.41...v1.0.42) (2024-03-26) ### Bug Fixes -* uploadMedia接口对base64://的支持 ([5d8945f](https://github.com/lc-cn/qq-group-bot/commit/5d8945fb5ed5bd0a84ebc0cec2d2b6fcf55356f3)) +* uploadMedia接口对base64://的支持 ([5d8945f](https://github.com/lc-cn/qq-official-bot/commit/5d8945fb5ed5bd0a84ebc0cec2d2b6fcf55356f3)) -## [1.0.41](https://github.com/lc-cn/qq-group-bot/compare/v1.0.40...v1.0.41) (2024-03-25) +## [1.0.41](https://github.com/lc-cn/qq-official-bot/compare/v1.0.40...v1.0.41) (2024-03-25) ### Bug Fixes -* uploadMedia接口暴露 ([5de0523](https://github.com/lc-cn/qq-group-bot/commit/5de0523371cf5bd6bad163bfb72a75b0ebc38505)) +* uploadMedia接口暴露 ([5de0523](https://github.com/lc-cn/qq-official-bot/commit/5de0523371cf5bd6bad163bfb72a75b0ebc38505)) -## [1.0.40](https://github.com/lc-cn/qq-group-bot/compare/v1.0.39...v1.0.40) (2024-03-24) +## [1.0.40](https://github.com/lc-cn/qq-official-bot/compare/v1.0.39...v1.0.40) (2024-03-24) ### Bug Fixes -* local file ([c97014a](https://github.com/lc-cn/qq-group-bot/commit/c97014ac78a017bca6436635bed3dec23a1b5509)) +* local file ([c97014a](https://github.com/lc-cn/qq-official-bot/commit/c97014ac78a017bca6436635bed3dec23a1b5509)) -## [1.0.39](https://github.com/lc-cn/qq-group-bot/compare/v1.0.38...v1.0.39) (2024-03-24) +## [1.0.39](https://github.com/lc-cn/qq-official-bot/compare/v1.0.38...v1.0.39) (2024-03-24) ### Bug Fixes -* 群聊支持发送Ark ([c2d5e7d](https://github.com/lc-cn/qq-group-bot/commit/c2d5e7df05df73162370d060a0617636e14108b2)) +* 群聊支持发送Ark ([c2d5e7d](https://github.com/lc-cn/qq-official-bot/commit/c2d5e7df05df73162370d060a0617636e14108b2)) -## [1.0.38](https://github.com/lc-cn/qq-group-bot/compare/v1.0.37...v1.0.38) (2024-03-24) +## [1.0.38](https://github.com/lc-cn/qq-official-bot/compare/v1.0.37...v1.0.38) (2024-03-24) ### Bug Fixes -* 增加主动消息开启/拒绝事件 ([6470a14](https://github.com/lc-cn/qq-group-bot/commit/6470a1457f899e6a7b60ee29030bbab3b4504581)) +* 增加主动消息开启/拒绝事件 ([6470a14](https://github.com/lc-cn/qq-official-bot/commit/6470a1457f899e6a7b60ee29030bbab3b4504581)) -## [1.0.37](https://github.com/lc-cn/qq-group-bot/compare/v1.0.36...v1.0.37) (2024-03-24) +## [1.0.37](https://github.com/lc-cn/qq-official-bot/compare/v1.0.36...v1.0.37) (2024-03-24) ### Bug Fixes -* 群聊、私信支持本地文件/base64/Buffer/网络url发送 ([a12b24e](https://github.com/lc-cn/qq-group-bot/commit/a12b24ef41521d999e6bfdadb581604bc3e90da3)) +* 群聊、私信支持本地文件/base64/Buffer/网络url发送 ([a12b24e](https://github.com/lc-cn/qq-official-bot/commit/a12b24ef41521d999e6bfdadb581604bc3e90da3)) -## [1.0.36](https://github.com/lc-cn/qq-group-bot/compare/v1.0.35...v1.0.36) (2024-03-23) +## [1.0.36](https://github.com/lc-cn/qq-official-bot/compare/v1.0.35...v1.0.36) (2024-03-23) ### Bug Fixes -* code error ([25ad7ee](https://github.com/lc-cn/qq-group-bot/commit/25ad7ee330c283da3c3ee3daa4741545defd55d0)) +* code error ([25ad7ee](https://github.com/lc-cn/qq-official-bot/commit/25ad7ee330c283da3c3ee3daa4741545defd55d0)) -## [1.0.35](https://github.com/lc-cn/qq-group-bot/compare/v1.0.34...v1.0.35) (2024-03-23) +## [1.0.35](https://github.com/lc-cn/qq-official-bot/compare/v1.0.34...v1.0.35) (2024-03-23) ### Bug Fixes -* add group/user recall msg method ([73663b9](https://github.com/lc-cn/qq-group-bot/commit/73663b9297571f72efcf3c3d57c7eff03c630c16)) -* change error method name ([b613ab4](https://github.com/lc-cn/qq-group-bot/commit/b613ab473e6b6ae8285541cede7d1edc433dd365)) -* Update Release Action ([e691408](https://github.com/lc-cn/qq-group-bot/commit/e691408c0aa6df71c430f70e5c9189e7e5eb2c47)) +* add group/user recall msg method ([73663b9](https://github.com/lc-cn/qq-official-bot/commit/73663b9297571f72efcf3c3d57c7eff03c630c16)) +* change error method name ([b613ab4](https://github.com/lc-cn/qq-official-bot/commit/b613ab473e6b6ae8285541cede7d1edc433dd365)) +* Update Release Action ([e691408](https://github.com/lc-cn/qq-official-bot/commit/e691408c0aa6df71c430f70e5c9189e7e5eb2c47)) -## [1.0.34](https://github.com/lc-cn/qq-group-bot/compare/v1.0.33...v1.0.34) (2024-02-22) +## [1.0.34](https://github.com/lc-cn/qq-official-bot/compare/v1.0.33...v1.0.34) (2024-02-22) ### Bug Fixes -* actions/checkout@v4,actions/setup-node@v4,add package-lock.json ([646493b](https://github.com/lc-cn/qq-group-bot/commit/646493b68ee33a544c93fce4901d8f9ca2fa8733)) -* string msg ([4395f28](https://github.com/lc-cn/qq-group-bot/commit/4395f28eed5395c4f74790ec80d455a12ebab93f)) -* Update Build Docs Action ([99fcfe7](https://github.com/lc-cn/qq-group-bot/commit/99fcfe7dab8c68ae3bf4345c4aa724f414837405)) -* Update Build Docs Action ([5bcf0e2](https://github.com/lc-cn/qq-group-bot/commit/5bcf0e2a2671935015ca90b8ad4ba20ad36f8a80)) -* Update Build Docs Action ([df6cf2b](https://github.com/lc-cn/qq-group-bot/commit/df6cf2b5bf3e6759b9b065c33ef69eba00e56ed8)) -* use ali mirror ([2fc7690](https://github.com/lc-cn/qq-group-bot/commit/2fc7690016c53c7a8c91750951670192c9c24063)) -* 消息模板字符串不解析Bug ([2d98fec](https://github.com/lc-cn/qq-group-bot/commit/2d98fec8006e16f275bad5495c3c4fc4e1e78e7b)) +* actions/checkout@v4,actions/setup-node@v4,add package-lock.json ([646493b](https://github.com/lc-cn/qq-official-bot/commit/646493b68ee33a544c93fce4901d8f9ca2fa8733)) +* string msg ([4395f28](https://github.com/lc-cn/qq-official-bot/commit/4395f28eed5395c4f74790ec80d455a12ebab93f)) +* Update Build Docs Action ([99fcfe7](https://github.com/lc-cn/qq-official-bot/commit/99fcfe7dab8c68ae3bf4345c4aa724f414837405)) +* Update Build Docs Action ([5bcf0e2](https://github.com/lc-cn/qq-official-bot/commit/5bcf0e2a2671935015ca90b8ad4ba20ad36f8a80)) +* Update Build Docs Action ([df6cf2b](https://github.com/lc-cn/qq-official-bot/commit/df6cf2b5bf3e6759b9b065c33ef69eba00e56ed8)) +* use ali mirror ([2fc7690](https://github.com/lc-cn/qq-official-bot/commit/2fc7690016c53c7a8c91750951670192c9c24063)) +* 消息模板字符串不解析Bug ([2d98fec](https://github.com/lc-cn/qq-official-bot/commit/2d98fec8006e16f275bad5495c3c4fc4e1e78e7b)) -## [1.0.33](https://github.com/lc-cn/qq-group-bot/compare/v1.0.32...v1.0.33) (2024-02-18) +## [1.0.33](https://github.com/lc-cn/qq-official-bot/compare/v1.0.32...v1.0.33) (2024-02-18) ### Bug Fixes -* 附件增加 name 字段 ([fd5b519](https://github.com/lc-cn/qq-group-bot/commit/fd5b5190a5e9e410d3ec848e87276b3a76d55e07)) +* 附件增加 name 字段 ([fd5b519](https://github.com/lc-cn/qq-official-bot/commit/fd5b5190a5e9e410d3ec848e87276b3a76d55e07)) -## [1.0.32](https://github.com/lc-cn/qq-group-bot/compare/v1.0.31...v1.0.32) (2024-02-17) +## [1.0.32](https://github.com/lc-cn/qq-official-bot/compare/v1.0.31...v1.0.32) (2024-02-17) ### Bug Fixes -* 发送完消息，消息数组没了 ([2865945](https://github.com/lc-cn/qq-group-bot/commit/2865945ebbd63f8258321327bc3a549a2c40206b)) +* 发送完消息，消息数组没了 ([2865945](https://github.com/lc-cn/qq-official-bot/commit/2865945ebbd63f8258321327bc3a549a2c40206b)) -## [1.0.31](https://github.com/lc-cn/qq-group-bot/compare/v1.0.30...v1.0.31) (2024-02-16) +## [1.0.31](https://github.com/lc-cn/qq-official-bot/compare/v1.0.30...v1.0.31) (2024-02-16) ### Bug Fixes -* file:// 开头无法发送，同时带 reply file 无法发送 ([831fbb8](https://github.com/lc-cn/qq-group-bot/commit/831fbb8a796b4939b0dbc3029dd12c756ee86948)) -* friendly img brief ([e8d6d65](https://github.com/lc-cn/qq-group-bot/commit/e8d6d65346f6908d4d5d8c91c7a5f32052be6ba4)) -* 添加部分文档 ([a577036](https://github.com/lc-cn/qq-group-bot/commit/a577036557cf4c601cfef91403a92f11d8122898)) +* file:// 开头无法发送，同时带 reply file 无法发送 ([831fbb8](https://github.com/lc-cn/qq-official-bot/commit/831fbb8a796b4939b0dbc3029dd12c756ee86948)) +* friendly img brief ([e8d6d65](https://github.com/lc-cn/qq-official-bot/commit/e8d6d65346f6908d4d5d8c91c7a5f32052be6ba4)) +* 添加部分文档 ([a577036](https://github.com/lc-cn/qq-official-bot/commit/a577036557cf4c601cfef91403a92f11d8122898)) -## [1.0.30](https://github.com/lc-cn/qq-group-bot/compare/v1.0.29...v1.0.30) (2024-01-19) +## [1.0.30](https://github.com/lc-cn/qq-official-bot/compare/v1.0.29...v1.0.30) (2024-01-19) ### Bug Fixes -* friendly img brief ([706b572](https://github.com/lc-cn/qq-group-bot/commit/706b5728ed9b390d87c8b686c1b2d0e401abaeed)) -* 将报错信息输出到debug ([bc4aabf](https://github.com/lc-cn/qq-group-bot/commit/bc4aabfcfe6e6df0c1c4b3381e7ce9a21d2459bc)) +* friendly img brief ([706b572](https://github.com/lc-cn/qq-official-bot/commit/706b5728ed9b390d87c8b686c1b2d0e401abaeed)) +* 将报错信息输出到debug ([bc4aabf](https://github.com/lc-cn/qq-official-bot/commit/bc4aabfcfe6e6df0c1c4b3381e7ce9a21d2459bc)) -## [1.0.29](https://github.com/lc-cn/qq-group-bot/compare/v1.0.28...v1.0.29) (2024-01-19) +## [1.0.29](https://github.com/lc-cn/qq-official-bot/compare/v1.0.28...v1.0.29) (2024-01-19) ### Bug Fixes -* friendly error ([2bc6360](https://github.com/lc-cn/qq-group-bot/commit/2bc63601110a12e85e4b3f8c0ea4351ca020cfbb)) +* friendly error ([2bc6360](https://github.com/lc-cn/qq-official-bot/commit/2bc63601110a12e85e4b3f8c0ea4351ca020cfbb)) -## [1.0.28](https://github.com/lc-cn/qq-group-bot/compare/v1.0.27...v1.0.28) (2024-01-19) +## [1.0.28](https://github.com/lc-cn/qq-official-bot/compare/v1.0.27...v1.0.28) (2024-01-19) ### Bug Fixes -* friendly media brief ([6993156](https://github.com/lc-cn/qq-group-bot/commit/6993156e066a9d16335b9730c93939ada985d4d0)) +* friendly media brief ([6993156](https://github.com/lc-cn/qq-official-bot/commit/6993156e066a9d16335b9730c93939ada985d4d0)) -## [1.0.27](https://github.com/lc-cn/qq-group-bot/compare/v1.0.26...v1.0.27) (2024-01-19) +## [1.0.27](https://github.com/lc-cn/qq-official-bot/compare/v1.0.26...v1.0.27) (2024-01-19) ### Bug Fixes -* friendly media brief ([ca003a8](https://github.com/lc-cn/qq-group-bot/commit/ca003a8a0ec23ec963ec5c97a0de85a9b8ec9661)) -* package-lock ([fccdba3](https://github.com/lc-cn/qq-group-bot/commit/fccdba34f8b9e9aa0b3ead5957e715cbaf64ab3e)) +* friendly media brief ([ca003a8](https://github.com/lc-cn/qq-official-bot/commit/ca003a8a0ec23ec963ec5c97a0de85a9b8ec9661)) +* package-lock ([fccdba3](https://github.com/lc-cn/qq-official-bot/commit/fccdba34f8b9e9aa0b3ead5957e715cbaf64ab3e)) -## [1.0.26](https://github.com/lc-cn/qq-group-bot/compare/v1.0.25...v1.0.26) (2024-01-19) +## [1.0.26](https://github.com/lc-cn/qq-official-bot/compare/v1.0.25...v1.0.26) (2024-01-19) ### Bug Fixes -* 使用 formdata-node ([5ad543c](https://github.com/lc-cn/qq-group-bot/commit/5ad543c68a8170890e69a03262e4941cf964181f)) +* 使用 formdata-node ([5ad543c](https://github.com/lc-cn/qq-official-bot/commit/5ad543c68a8170890e69a03262e4941cf964181f)) -## [1.0.25](https://github.com/lc-cn/qq-group-bot/compare/v1.0.24...v1.0.25) (2024-01-19) +## [1.0.25](https://github.com/lc-cn/qq-official-bot/compare/v1.0.24...v1.0.25) (2024-01-19) ### Bug Fixes -* 使用ReadStream替代blob ([d6b35b5](https://github.com/lc-cn/qq-group-bot/commit/d6b35b579bc0440f02750ce46ccd933edcab228e)) +* 使用ReadStream替代blob ([d6b35b5](https://github.com/lc-cn/qq-official-bot/commit/d6b35b579bc0440f02750ce46ccd933edcab228e)) -## [1.0.24](https://github.com/lc-cn/qq-group-bot/compare/v1.0.23...v1.0.24) (2024-01-19) +## [1.0.24](https://github.com/lc-cn/qq-official-bot/compare/v1.0.23...v1.0.24) (2024-01-19) ### Bug Fixes -* 增强代码健壮性 ([6f112c5](https://github.com/lc-cn/qq-group-bot/commit/6f112c57b8ef7a64c9b28b496e676e50254c0ca1)) +* 增强代码健壮性 ([6f112c5](https://github.com/lc-cn/qq-official-bot/commit/6f112c57b8ef7a64c9b28b496e676e50254c0ca1)) -## [1.0.23](https://github.com/lc-cn/qq-group-bot/compare/v1.0.22...v1.0.23) (2024-01-19) +## [1.0.23](https://github.com/lc-cn/qq-official-bot/compare/v1.0.22...v1.0.23) (2024-01-19) ### Bug Fixes -* 图片发送不存本地 ([efa0b48](https://github.com/lc-cn/qq-group-bot/commit/efa0b48fec7c61dd261ba3893a6e366598ae744f)) +* 图片发送不存本地 ([efa0b48](https://github.com/lc-cn/qq-official-bot/commit/efa0b48fec7c61dd261ba3893a6e366598ae744f)) -## [1.0.22](https://github.com/lc-cn/qq-group-bot/compare/v1.0.21...v1.0.22) (2024-01-19) +## [1.0.22](https://github.com/lc-cn/qq-official-bot/compare/v1.0.21...v1.0.22) (2024-01-19) ### Bug Fixes -* 完善类型约束 ([b437359](https://github.com/lc-cn/qq-group-bot/commit/b437359a909c96cac1d0406c06cd9e24d25e4ffe)) -* 获取频道消息 ([2525399](https://github.com/lc-cn/qq-group-bot/commit/252539952c7ce5d9970b1a45ec868b4c79782e21)) +* 完善类型约束 ([b437359](https://github.com/lc-cn/qq-official-bot/commit/b437359a909c96cac1d0406c06cd9e24d25e4ffe)) +* 获取频道消息 ([2525399](https://github.com/lc-cn/qq-official-bot/commit/252539952c7ce5d9970b1a45ec868b4c79782e21)) -## [1.0.21](https://github.com/lc-cn/qq-group-bot/compare/v1.0.20...v1.0.21) (2024-01-19) +## [1.0.21](https://github.com/lc-cn/qq-official-bot/compare/v1.0.20...v1.0.21) (2024-01-19) ### Bug Fixes -* 频道接口支持上传本地图片或Buffer或base64 ([6fa63eb](https://github.com/lc-cn/qq-group-bot/commit/6fa63ebe3a64f78d7f7e59da43cc0cad4e748dc0)) -* 频道接口支持上传本地图片或Buffer或base64 ([256746d](https://github.com/lc-cn/qq-group-bot/commit/256746dcb482e234ed7e2482e7a8126f07367efd)) +* 频道接口支持上传本地图片或Buffer或base64 ([6fa63eb](https://github.com/lc-cn/qq-official-bot/commit/6fa63ebe3a64f78d7f7e59da43cc0cad4e748dc0)) +* 频道接口支持上传本地图片或Buffer或base64 ([256746d](https://github.com/lc-cn/qq-official-bot/commit/256746dcb482e234ed7e2482e7a8126f07367efd)) -## [1.0.20](https://github.com/lc-cn/qq-group-bot/compare/v1.0.19...v1.0.20) (2024-01-19) +## [1.0.20](https://github.com/lc-cn/qq-official-bot/compare/v1.0.19...v1.0.20) (2024-01-19) ### Bug Fixes -* 增加音频/直播/论坛子频道事件 ([37b6ce2](https://github.com/lc-cn/qq-group-bot/commit/37b6ce2770b20152ea4b532d3c507871732f4540)) -* 将direct事件移动至private事件 ([37b6ce2](https://github.com/lc-cn/qq-group-bot/commit/37b6ce2770b20152ea4b532d3c507871732f4540)) -* 连接出错标明原因，事件解析失败增加debug日志 ([c2b77f2](https://github.com/lc-cn/qq-group-bot/commit/c2b77f2256f03d0fc74b10f6c25444a0ae3cf121)) +* 增加音频/直播/论坛子频道事件 ([37b6ce2](https://github.com/lc-cn/qq-official-bot/commit/37b6ce2770b20152ea4b532d3c507871732f4540)) +* 将direct事件移动至private事件 ([37b6ce2](https://github.com/lc-cn/qq-official-bot/commit/37b6ce2770b20152ea4b532d3c507871732f4540)) +* 连接出错标明原因，事件解析失败增加debug日志 ([c2b77f2](https://github.com/lc-cn/qq-official-bot/commit/c2b77f2256f03d0fc74b10f6c25444a0ae3cf121)) -## [1.0.19](https://github.com/lc-cn/qq-group-bot/compare/v1.0.18...v1.0.19) (2024-01-18) +## [1.0.19](https://github.com/lc-cn/qq-official-bot/compare/v1.0.18...v1.0.19) (2024-01-18) ### Bug Fixes -* 通知事件格式化 ([cd3b5a7](https://github.com/lc-cn/qq-group-bot/commit/cd3b5a7f95ed23fecf43d3aa9953a147df455273)) +* 通知事件格式化 ([cd3b5a7](https://github.com/lc-cn/qq-official-bot/commit/cd3b5a7f95ed23fecf43d3aa9953a147df455273)) -## [1.0.18](https://github.com/lc-cn/qq-group-bot/compare/v1.0.17...v1.0.18) (2024-01-18) +## [1.0.18](https://github.com/lc-cn/qq-official-bot/compare/v1.0.17...v1.0.18) (2024-01-18) ### Bug Fixes -* 添加接口 getGuildInfo ([fc14a4a](https://github.com/lc-cn/qq-group-bot/commit/fc14a4ad58ee5a52b3f56654e47a085b0e5267ca)) +* 添加接口 getGuildInfo ([fc14a4a](https://github.com/lc-cn/qq-official-bot/commit/fc14a4ad58ee5a52b3f56654e47a085b0e5267ca)) -## [1.0.17](https://github.com/lc-cn/qq-group-bot/compare/v1.0.16...v1.0.17) (2024-01-18) +## [1.0.17](https://github.com/lc-cn/qq-official-bot/compare/v1.0.16...v1.0.17) (2024-01-18) ### Bug Fixes -* 事件错误 ([15f103d](https://github.com/lc-cn/qq-group-bot/commit/15f103ded1eef539a382df16fb1f9ac984e213f2)) -* 类型提示优化 ([388a985](https://github.com/lc-cn/qq-group-bot/commit/388a9851b600c027f585a7732f9c6ae910c850cd)) +* 事件错误 ([15f103d](https://github.com/lc-cn/qq-official-bot/commit/15f103ded1eef539a382df16fb1f9ac984e213f2)) +* 类型提示优化 ([388a985](https://github.com/lc-cn/qq-official-bot/commit/388a9851b600c027f585a7732f9c6ae910c850cd)) -## [1.0.16](https://github.com/lc-cn/qq-group-bot/compare/v1.0.15...v1.0.16) (2024-01-18) +## [1.0.16](https://github.com/lc-cn/qq-official-bot/compare/v1.0.15...v1.0.16) (2024-01-18) ### Bug Fixes -* 按钮操作格式化 ([7af8bd7](https://github.com/lc-cn/qq-group-bot/commit/7af8bd7eafbc758b07977d402cfcb8d47cc908d1)) +* 按钮操作格式化 ([7af8bd7](https://github.com/lc-cn/qq-official-bot/commit/7af8bd7eafbc758b07977d402cfcb8d47cc908d1)) -## [1.0.15](https://github.com/lc-cn/qq-group-bot/compare/v1.0.14...v1.0.15) (2024-01-15) +## [1.0.15](https://github.com/lc-cn/qq-official-bot/compare/v1.0.14...v1.0.15) (2024-01-15) ### Bug Fixes -* replyAction ([0fe0831](https://github.com/lc-cn/qq-group-bot/commit/0fe0831284176eb4a4ac22b12569f9056e885c36)) +* replyAction ([0fe0831](https://github.com/lc-cn/qq-official-bot/commit/0fe0831284176eb4a4ac22b12569f9056e885c36)) -## [1.0.14](https://github.com/lc-cn/qq-group-bot/compare/v1.0.13...v1.0.14) (2024-01-15) +## [1.0.14](https://github.com/lc-cn/qq-official-bot/compare/v1.0.13...v1.0.14) (2024-01-15) ### Bug Fixes -* 被动回复失败 ([7273ed8](https://github.com/lc-cn/qq-group-bot/commit/7273ed83cd63b552b23029d86a413728c1f235c3)) +* 被动回复失败 ([7273ed8](https://github.com/lc-cn/qq-official-bot/commit/7273ed83cd63b552b23029d86a413728c1f235c3)) -## [1.0.13](https://github.com/lc-cn/qq-group-bot/compare/v1.0.12...v1.0.13) (2024-01-15) +## [1.0.13](https://github.com/lc-cn/qq-official-bot/compare/v1.0.12...v1.0.13) (2024-01-15) ### Bug Fixes -* replyAction ([decec4b](https://github.com/lc-cn/qq-group-bot/commit/decec4bf4261f96fdf883657a1fd6be7559a0cda)) +* replyAction ([decec4b](https://github.com/lc-cn/qq-official-bot/commit/decec4bf4261f96fdf883657a1fd6be7559a0cda)) -## [1.0.12](https://github.com/lc-cn/qq-group-bot/compare/v1.0.11...v1.0.12) (2024-01-15) +## [1.0.12](https://github.com/lc-cn/qq-official-bot/compare/v1.0.11...v1.0.12) (2024-01-15) ### Bug Fixes -* 增加频道上下麦接口 ([7778073](https://github.com/lc-cn/qq-group-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) -* 增加频道帖子相关接口 ([7778073](https://github.com/lc-cn/qq-group-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) -* 增加频道日程相关接口 ([7778073](https://github.com/lc-cn/qq-group-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) -* 增加频道音频控制接口 ([7778073](https://github.com/lc-cn/qq-group-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) +* 增加频道上下麦接口 ([7778073](https://github.com/lc-cn/qq-official-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) +* 增加频道帖子相关接口 ([7778073](https://github.com/lc-cn/qq-official-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) +* 增加频道日程相关接口 ([7778073](https://github.com/lc-cn/qq-official-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) +* 增加频道音频控制接口 ([7778073](https://github.com/lc-cn/qq-official-bot/commit/7778073bee0c7e3f99f54b059308e9f64e9eb026)) -## [1.0.11](https://github.com/lc-cn/qq-group-bot/compare/v1.0.10...v1.0.11) (2024-01-15) +## [1.0.11](https://github.com/lc-cn/qq-official-bot/compare/v1.0.10...v1.0.11) (2024-01-15) ### Bug Fixes -* 修复获取表态用户列表错误 ([0030d98](https://github.com/lc-cn/qq-group-bot/commit/0030d98c49435cbe97409f1001cf1b7b9ac37a21)) +* 修复获取表态用户列表错误 ([0030d98](https://github.com/lc-cn/qq-official-bot/commit/0030d98c49435cbe97409f1001cf1b7b9ac37a21)) -## [1.0.10](https://github.com/lc-cn/qq-group-bot/compare/v1.0.9...v1.0.10) (2024-01-15) +## [1.0.10](https://github.com/lc-cn/qq-official-bot/compare/v1.0.9...v1.0.10) (2024-01-15) ### Bug Fixes -* 增加操作回应能力 ([3bc4548](https://github.com/lc-cn/qq-group-bot/commit/3bc45485f73f842c3c3cb360b799fd7a1488db65)) -* 频道消息增加消息表态能力 ([3bc4548](https://github.com/lc-cn/qq-group-bot/commit/3bc45485f73f842c3c3cb360b799fd7a1488db65)) +* 增加操作回应能力 ([3bc4548](https://github.com/lc-cn/qq-official-bot/commit/3bc45485f73f842c3c3cb360b799fd7a1488db65)) +* 频道消息增加消息表态能力 ([3bc4548](https://github.com/lc-cn/qq-official-bot/commit/3bc45485f73f842c3c3cb360b799fd7a1488db65)) -## [1.0.9](https://github.com/lc-cn/qq-group-bot/compare/v1.0.8...v1.0.9) (2024-01-09) +## [1.0.9](https://github.com/lc-cn/qq-official-bot/compare/v1.0.8...v1.0.9) (2024-01-09) ### Bug Fixes -* message_id错误 ([5c393d7](https://github.com/lc-cn/qq-group-bot/commit/5c393d7b3f2c451aaee62efeade17cdfe853f2f0)) +* message_id错误 ([5c393d7](https://github.com/lc-cn/qq-official-bot/commit/5c393d7b3f2c451aaee62efeade17cdfe853f2f0)) -## [1.0.8](https://github.com/lc-cn/qq-group-bot/compare/v1.0.7...v1.0.8) (2024-01-09) +## [1.0.8](https://github.com/lc-cn/qq-official-bot/compare/v1.0.7...v1.0.8) (2024-01-09) ### Bug Fixes -* 重复监听ws事件问题 ([0107e2c](https://github.com/lc-cn/qq-group-bot/commit/0107e2ca140b52c99687b3199ed6d161c607f5b9)) +* 重复监听ws事件问题 ([0107e2c](https://github.com/lc-cn/qq-official-bot/commit/0107e2ca140b52c99687b3199ed6d161c607f5b9)) -## [1.0.7](https://github.com/lc-cn/qq-group-bot/compare/v1.0.6...v1.0.7) (2023-12-30) +## [1.0.7](https://github.com/lc-cn/qq-official-bot/compare/v1.0.6...v1.0.7) (2023-12-30) ### Bug Fixes -* 编译类型错误 ([8259f7d](https://github.com/lc-cn/qq-group-bot/commit/8259f7df6da1004557c72b762b78c5ef70d3cf2a)) +* 编译类型错误 ([8259f7d](https://github.com/lc-cn/qq-official-bot/commit/8259f7df6da1004557c72b762b78c5ef70d3cf2a)) -## [1.0.6](https://github.com/lc-cn/qq-group-bot/compare/v1.0.5...v1.0.6) (2023-12-30) +## [1.0.6](https://github.com/lc-cn/qq-official-bot/compare/v1.0.5...v1.0.6) (2023-12-30) ### Bug Fixes -* 重连错误 ([412f681](https://github.com/lc-cn/qq-group-bot/commit/412f681bf56209b54e73d453aa802082b4631fe0)) +* 重连错误 ([412f681](https://github.com/lc-cn/qq-official-bot/commit/412f681bf56209b54e73d453aa802082b4631fe0)) -## [1.0.5](https://github.com/lc-cn/qq-group-bot/compare/v1.0.4...v1.0.5) (2023-12-30) +## [1.0.5](https://github.com/lc-cn/qq-official-bot/compare/v1.0.4...v1.0.5) (2023-12-30) ### Bug Fixes -* 关闭失败 ([103fab2](https://github.com/lc-cn/qq-group-bot/commit/103fab250a85870dbf915c407754ef48caba3281)) +* 关闭失败 ([103fab2](https://github.com/lc-cn/qq-official-bot/commit/103fab250a85870dbf915c407754ef48caba3281)) -## [1.0.4](https://github.com/lc-cn/qq-group-bot/compare/v1.0.3...v1.0.4) (2023-12-30) +## [1.0.4](https://github.com/lc-cn/qq-official-bot/compare/v1.0.3...v1.0.4) (2023-12-30) ### Bug Fixes -* 允许关闭 ([10005e8](https://github.com/lc-cn/qq-group-bot/commit/10005e816f081dbf625d709c8ee39f563662e8f8)) +* 允许关闭 ([10005e8](https://github.com/lc-cn/qq-official-bot/commit/10005e816f081dbf625d709c8ee39f563662e8f8)) -## [1.0.3](https://github.com/lc-cn/qq-group-bot/compare/v1.0.2...v1.0.3) (2023-12-30) +## [1.0.3](https://github.com/lc-cn/qq-official-bot/compare/v1.0.2...v1.0.3) (2023-12-30) ### Bug Fixes -* 添加撤回消息接口（仅频道私信和子频道消息可用） ([852d100](https://github.com/lc-cn/qq-group-bot/commit/852d100a9554314228721db76eaab1601c3f9eb2)) +* 添加撤回消息接口（仅频道私信和子频道消息可用） ([852d100](https://github.com/lc-cn/qq-official-bot/commit/852d100a9554314228721db76eaab1601c3f9eb2)) -## [1.0.2](https://github.com/lc-cn/qq-group-bot/compare/v1.0.1...v1.0.2) (2023-12-30) +## [1.0.2](https://github.com/lc-cn/qq-official-bot/compare/v1.0.1...v1.0.2) (2023-12-30) ### Bug Fixes -* 添加接口类型声明 ([ebf3383](https://github.com/lc-cn/qq-group-bot/commit/ebf338343ad9df9591372bc857bc6037d398742b)) +* 添加接口类型声明 ([ebf3383](https://github.com/lc-cn/qq-official-bot/commit/ebf338343ad9df9591372bc857bc6037d398742b)) -## [1.0.1](https://github.com/lc-cn/qq-group-bot/compare/v1.0.0...v1.0.1) (2023-12-12) +## [1.0.1](https://github.com/lc-cn/qq-official-bot/compare/v1.0.0...v1.0.1) (2023-12-12) ### Bug Fixes -* 增加KeyboardElem 用于发送按钮模板； ([77414c3](https://github.com/lc-cn/qq-group-bot/commit/77414c3afc96c38bb004b78d69c69a4f7fba322c)) +* 增加KeyboardElem 用于发送按钮模板； ([77414c3](https://github.com/lc-cn/qq-official-bot/commit/77414c3afc96c38bb004b78d69c69a4f7fba322c)) ## 1.0.0 (2023-12-05) ### Bug Fixes -* removeAt配置无效问题 ([b20fee8](https://github.com/lc-cn/qq-group-bot/commit/b20fee8b41ad2082bfb3d22802f6d8ead6cd0044)) -* 仅对支持的内容进行解码 ([bdbe0b9](https://github.com/lc-cn/qq-group-bot/commit/bdbe0b9657d8ec6d8cf0f85bbda5f2194e6d81eb)) -* 图片/语音/视频发送修复 ([1cf39c3](https://github.com/lc-cn/qq-group-bot/commit/1cf39c3f1588a5e564592fb2645b7938bf7b58e7)) -* 图片发送修复 ([66f24d1](https://github.com/lc-cn/qq-group-bot/commit/66f24d185ceae5a4df34cee150e13d9c96aac5e5)) -* 图片发送修复 ([029b578](https://github.com/lc-cn/qq-group-bot/commit/029b578dffc65dd7133031f4b1e5d46ba463cebc)) -* 图片接收修复 ([ad50b4c](https://github.com/lc-cn/qq-group-bot/commit/ad50b4ce8e89ad151d83ee3c7ab210511122527f)) -* 处理空包 ([4bf36eb](https://github.com/lc-cn/qq-group-bot/commit/4bf36eb3914e958564c430ecf501897434de68e9)) -* 支持发送ark/embed （仅频道和频道私信支持） ([fe4dacd](https://github.com/lc-cn/qq-group-bot/commit/fe4dacdc376f6ba3fa60c34e17f70b012965912a)) -* 添加加群链接 ([5a02297](https://github.com/lc-cn/qq-group-bot/commit/5a02297a282657d1b631ad9cde182cc0c681a8a0)) -* 请求支持配置超时时间(config.timeout) 默认为5秒 ([ce8e70f](https://github.com/lc-cn/qq-group-bot/commit/ce8e70f82e442b6a548f951868ebc3029f137a67)) -* 返回引用消息的信息，reply类型的message_id改为id ([a11bfc2](https://github.com/lc-cn/qq-group-bot/commit/a11bfc249c5bcb5d819cd86519e630c9367932a8)) +* removeAt配置无效问题 ([b20fee8](https://github.com/lc-cn/qq-official-bot/commit/b20fee8b41ad2082bfb3d22802f6d8ead6cd0044)) +* 仅对支持的内容进行解码 ([bdbe0b9](https://github.com/lc-cn/qq-official-bot/commit/bdbe0b9657d8ec6d8cf0f85bbda5f2194e6d81eb)) +* 图片/语音/视频发送修复 ([1cf39c3](https://github.com/lc-cn/qq-official-bot/commit/1cf39c3f1588a5e564592fb2645b7938bf7b58e7)) +* 图片发送修复 ([66f24d1](https://github.com/lc-cn/qq-official-bot/commit/66f24d185ceae5a4df34cee150e13d9c96aac5e5)) +* 图片发送修复 ([029b578](https://github.com/lc-cn/qq-official-bot/commit/029b578dffc65dd7133031f4b1e5d46ba463cebc)) +* 图片接收修复 ([ad50b4c](https://github.com/lc-cn/qq-official-bot/commit/ad50b4ce8e89ad151d83ee3c7ab210511122527f)) +* 处理空包 ([4bf36eb](https://github.com/lc-cn/qq-official-bot/commit/4bf36eb3914e958564c430ecf501897434de68e9)) +* 支持发送ark/embed （仅频道和频道私信支持） ([fe4dacd](https://github.com/lc-cn/qq-official-bot/commit/fe4dacdc376f6ba3fa60c34e17f70b012965912a)) +* 添加加群链接 ([5a02297](https://github.com/lc-cn/qq-official-bot/commit/5a02297a282657d1b631ad9cde182cc0c681a8a0)) +* 请求支持配置超时时间(config.timeout) 默认为5秒 ([ce8e70f](https://github.com/lc-cn/qq-official-bot/commit/ce8e70f82e442b6a548f951868ebc3029f137a67)) +* 返回引用消息的信息，reply类型的message_id改为id ([a11bfc2](https://github.com/lc-cn/qq-official-bot/commit/a11bfc249c5bcb5d819cd86519e630c9367932a8)) diff --git a/README.md b/README.md index 649fcd3..254e6dc 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# qq-group-bot +# qq-official-bot [![qq group](https://img.shields.io/badge/group-446290761-blue?style=flat-square&labelColor=FAFAFA&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAD4AAAA+CAMAAABEH1h2AAACB1BMVEX///8AAADoHx/6rgjnFhb/tQj9/f3/sggEAgLyICD//vztICAGBgbrHx8MDAwJCQn7rwj09PTi4uKbm5uBgYHvICAREREODg79sQgkJCT39/f/+/HExMT3q6tNTU37vTRFMQI4JwIgFgHt7e3r6+vd3d3b29u7u7uwsLDyenp4eHjxc3NZWVn//fj//PTf399vb29UVFQ8PDwuLi76uCUgICDfHh7oGhoYGBgVFRWjcgf6+vrR0dG2traYmJiUlJRqampiYmJXV1dDQ0M2Njbk5OTX19fKysr+5a70lJTyfX1zc3P90Gz+yFBGRkbsRET+vCn6tyLUHBwcHBzDGhqxFxesFxeeFRV4EBD/twjGiwa0fwaodgUbAwMJBgD++PjT09O/v7+xsbGpqamoqKj4p6eJiYloaGgxMTEnJyfv7+/96Ojm5ubq5eX84ODP1NTOzs7Nzc3/wcH4vb34urqioqKKioqCfXTvZWWeY2OMfmCgh1G8l0TdqjrqKirZHR3mHBy3GBiXFBSSExN/EREmERHmDg76sAxVCwtICgr/vQlECQnupwjupgjrpQg4CAjUlAfQkgfMjwbAhga7gwYiBQWJYASAWgR3UwRrSwNiRQMUAgISAgISDQEUDgD/9+X+9uX60dH3sbH94aP94aK/kZG+kJCMjIzzhobwbm7uXl7uWlrpLCyLIqc8AAAEYklEQVRIx62Wd1vaUBTGcxACmIBYRpG2LEFoRcVi0SJaLLV1a927rXV277333nvv/SF7b3JNi+Qm2KfvPyT35Pck57znXg6jKNblYpl/00brTDpWVBRLz1g3LpatnUwXgKSC9GTtYujlq2GBVi/PnT5SAFkqOJIjzEZBVtHcqrgKKFqVC30YqDqsTpesBUHmlC0mXsVsKbN4tbZEFV9PKlXHMMWrhZoXM0wdqeV6VcsMIKgB32ziAfhN+KpBXDWo2VcJotDLt9axGwA2CPWuI8uVKpmTr+Q3MsVFMJFCn8HWuyPbSniSk3L20yDhSeRUK0Dr1/S6mekgwWFasWOkZg0xO+YgjOroLsHtHpKaV6l3lpiBKIUSCQVqAGp24EAKiMxLFPAwzGvppvn+W4UtWCoFwgq4DST1WLdFDYJZ0W3WHpBkU7SNLnXrkM9EBr/3+ZPEyKOHDx+NJJ489/pJNwl9QFPhGhDkfzp8S69D0iMJv7eGn/rF2JpCKh4Qt8v4gxt6S16GLPobD8bFbROg+0YK7Bux6DJ4dDviI5bQnauQbPeO3tHpnBYBdep0d0a9kvEVKl1D8n+RuHc7z+nMu30v8QLnrd43uy9neDTu93m9Pv94xuLl3VT8ULx/8OaYASgyjN0c7I8fouLHjHYjF+8dGLx29/Erw1/cq8d3rw0O9MY59MAxGr3njEmj0Zg4u9Fuinf3nu8fuHDx4oWB/vO93XETWuSE8Jk9FLzZqPkjE8fZ7UYku53DnCRjszy9pZPT5CCuc4ssfsBoygU3GQ/I4sf7znJGzqSIogfO9h2Xo3c5YOz6pb7uc9pqObJaq9We6+67dH0MHLtkcCsIevll6ke1RBBVa351/myZ+vwSBFll8A4QtZf5oBXpzpZSpJXfmqcOvt+J67WX9EJHNh00SztqhYhrW2g70hzMwutBVE2xhK9c+ExxDXmoPgt3g3SaSDjtNAK37EGDVeSi464iAPkjJwSLwSFEOeFz+3iwyaZOSndFi3WllFK67ORdc3hb94jG7VzR3FL6vXTlQVnjerD5c66MQCMOVOIMDPsZqvZj0laJX9KYEUiigKNiOyBN0nEhvr3CgV6SzBxphE5O4iGglY63ojCfFHbH8oV4A8vU4lFsllX8C4zVMmzDQjwIHYXEPn4fDd/HE8sKOyCz69kJTDM4LYjS8CjgAjGYn2Cp86wjKE8HHapzbQC3ZUQ+FsEtHWAUFeIFDyinER9iVLQOD39hmakJD4zr6JzE84ivzzpNEM2r0+VN7YnXeHbe+vfqVjxnv060N5UrwvkfPWiWue/F51kk3MgKnjaGI2Y8MdxHM47nU74C3abTo3lCnzfqA+zgrDsScc86hHllNE8I6dro/LurQ3q902lxDlmGn/neANEb37NhyxBadur1Q1ff0t/e1Nbu8VRVbd5c1dXlOX3q5ImjR0+cPHXa09WF16o8nva2pnzl9MvKlyGVl5Xl5wtPop+y+TWC/jf9BuxZscgeRqlfAAAAAElFTkSuQmCC&logoColor=000000)](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=rYaL-gcqTjWYqwBs9TDoVSXKu-i5ircB&authKey=TO02faBOpfhmfkw3YQuUCG2HxUEwWCuFdMBf5nSt3qyWD%2FqaO453O9Dx%2BK8JwBdM&noverify=0&group_code=446290761) ## 安装依赖 ```shell -npm i qq-group-bot # or yarn add qq-group-bot +npm i qq-official-bot # or yarn add qq-official-bot ``` ## 使用 ```js -const {Bot} = require('qq-group-bot') +const {Bot} = require('qq-official-bot') // 创建机器人 const bot = new Bot({ appid: '', // qq机器人的appID (必填) @@ -37,7 +37,7 @@ bot.start() ## 发送消息 ```javascript -const {Bot} = require('qq-group-bot') +const {Bot} = require('qq-official-bot') const bot = new Bot({ // ... }) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index c351774..fc088c2 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,7 +1,7 @@ import {defineConfig} from 'vitepress' export default defineConfig({ - base:"/qq-group-bot/", + base:"/qq-official-bot/", themeConfig: { returnToTopLabel:'返回顶部', lastUpdated:{ @@ -14,7 +14,7 @@ export default defineConfig({ } }, editLink: { - pattern: 'https://github.com/lc-cn/qq-group-bot/edit/main/docs/src/:path', + pattern: 'https://github.com/lc-cn/qq-official-bot/edit/main/docs/src/:path', text: '修改' }, nav: [ @@ -41,7 +41,7 @@ export default defineConfig({ { text: '频道消息事件', link: '/event/guildMessage' }, ] }, - { text: '更新日志', link: 'https://github.com/lc-cn/qq-group-bot/blob/master/CHANGELOG.md', target: '_blank', } + { text: '更新日志', link: 'https://github.com/lc-cn/qq-official-bot/blob/master/CHANGELOG.md', target: '_blank', } ], sidebar: [ { @@ -81,11 +81,11 @@ export default defineConfig({ } ], footer: { - message: 'Released under the MIT License.', + message: 'Released under the MIT License.', copyright: 'Copyright © 2023-present lc-cn' } }, - title: 'qq-group-bot', + title: 'qq-official-bot', srcDir: './src', outDir: "./dist", lastUpdated: true, diff --git a/docs/src/guide/instruction.md b/docs/src/guide/instruction.md index bcf0f97..8c4d5b7 100644 --- a/docs/src/guide/instruction.md +++ b/docs/src/guide/instruction.md @@ -2,13 +2,13 @@ layout: doc --- # 简介 -## 1. 什么是 “qq-group-bot” ? -`qq-group-bot` 是基于 `NodeJS` 编写的 qq官方机器人 开发SDK，它提供了一套 API 和工具，可以帮助开发者构建和使用 QQ 机器人。 +## 1. 什么是 “qq-official-bot” ? +`qq-official-bot` 是基于 `NodeJS` 编写的 qq官方机器人 开发SDK，它提供了一套 API 和工具，可以帮助开发者构建和使用 QQ 机器人。 -使用 `qq-group-bot`，开发者可以通过编写 JavaScript 或 TypeScript 代码来实现 QQ 群机器人的功能，如接收和发送消息、管理频道成员、频道信息等。该 SDK 提供了丰富的功能和事件回调，方便开发者根据自己的需求进行扩展和定制。 +使用 `qq-official-bot`，开发者可以通过编写 JavaScript 或 TypeScript 代码来实现 QQ 群机器人的功能，如接收和发送消息、管理频道成员、频道信息等。该 SDK 提供了丰富的功能和事件回调，方便开发者根据自己的需求进行扩展和定制。 -借助 `qq-group-bot`，开发者可以快速构建自己的 QQ 群机器人，并利用机器人在 QQ 群中实现自动化任务、消息处理、数据收集等功能。这对于频道管理、社区运营、消息推送等场景非常有用。 +借助 `qq-official-bot`，开发者可以快速构建自己的 QQ 群机器人，并利用机器人在 QQ 群中实现自动化任务、消息处理、数据收集等功能。这对于频道管理、社区运营、消息推送等场景非常有用。 -需要注意的是，`qq-group-bot` 是一个第三方开发的 SDK，并非由 QQ 官方提供或支持。开发者可以根据自己的需求选择合适的 SDK 或工具来进行 QQ 群机器人的开发。 -## 2. 如何使用 “qq-group-bot” ？ +需要注意的是，`qq-official-bot` 是一个第三方开发的 SDK，并非由 QQ 官方提供或支持。开发者可以根据自己的需求选择合适的 SDK 或工具来进行 QQ 群机器人的开发。 +## 2. 如何使用 “qq-official-bot” ？ 见[快速开始](./start.md) 章节 diff --git a/docs/src/guide/start.md b/docs/src/guide/start.md index 1cc0dec..b7633a8 100644 --- a/docs/src/guide/start.md +++ b/docs/src/guide/start.md @@ -2,7 +2,7 @@ layout: doc --- # 快速开始 -由于 `qq-group-bot` 是基于 `NodeJS` 编写，要使用 "qq-group-bot"，你可以按照以下步骤进行操作： +由于 `qq-official-bot` 是基于 `NodeJS` 编写，要使用 "qq-official-bot"，你可以按照以下步骤进行操作： ## 1. 安装 Node.js 首先，确保你的计算机上已经安装了 Node.js。你可以在 Node.js 的官方网站上下载并安装适合你操作系统的版本。 ## 2. 创建新项目 @@ -10,15 +10,15 @@ layout: doc ```shell npm init # 这将会引导你创建一个新的 `package.json` 文件，用于管理你的项目依赖和配置。 ``` -## 3. 安装 `qq-group-bot` 包 -运行以下命令来安装 `qq-group-bot` 包: +## 3. 安装 `qq-official-bot` 包 +运行以下命令来安装 `qq-official-bot` 包: ```shell -npm install qq-group-bot +npm install qq-official-bot ``` ## 4. 编写代码 创建一个 JavaScript 或 TypeScript 文件（例如 bot.js），并在其中编写你的 QQ 群机器人代码。你可以使用下面的示例代码作为起点： ```javascript -const {Bot} = require('qq-group-bot'); +const {Bot} = require('qq-official-bot'); const bot = new Bot({ // 在这里配置你的 QQ 机器人的appid和secret等信息 diff --git a/docs/src/index.md b/docs/src/index.md index bb98307..dcf30a3 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,7 +2,7 @@ layout: home hero: - name: qq-group-bot + name: qq-official-bot text: 基于NodeJS的qq官方机器人开发SDK actions: - theme: brand @@ -10,7 +10,7 @@ hero: link: /guide/start - theme: alt text: View on GitHub - link: https://github.com/lc-cn/qq-group-bot + link: https://github.com/lc-cn/qq-official-bot features: - title: 上手简单 details: 方法使用参考icqq设计，更容易上手 diff --git a/docs/src/segment/index.md b/docs/src/segment/index.md index d53d975..8267824 100644 --- a/docs/src/segment/index.md +++ b/docs/src/segment/index.md @@ -5,9 +5,9 @@ \{ type: 消息段类型, data: 消息段数据 \} - 在使用 **icqq** 的时候，发送消息时，你可以直接发送 **string** 类型的消息，也可以发送指定类型的 **segment**，也可以发送包含 **string** 或 **segment** 的数组 - 但是在使用过程中，我们发现其实某些 **segment** 其实不能同时发送，比如同时发送 **audio** 和 **video**，而 icqq 的 **Sendable** 并不能正确的提示用户该错误的发生 -- 在 **qq-group-bot** 中，我们重新定义了 **Sendable** 的约束范围，使得其能获得正确的类型提示 +- 在 **qq-official-bot** 中，我们重新定义了 **Sendable** 的约束范围，使得其能获得正确的类型提示 ## Sendable -**qq-group-bot** 中 **Sendable** 定义如下： +**qq-official-bot** 中 **Sendable** 定义如下： ```typescript // 重复组合的消息元素 type RepeatableCombineElem = TextElem // 文本消息段 diff --git a/package-lock.json b/package-lock.json index 6c2cf58..3d9ae42 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "qq-group-bot", + "name": "qq-official-bot", "version": "1.1.1", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "qq-group-bot", + "name": "qq-official-bot", "version": "1.1.1", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 9d185ab..c56f625 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "qq-group-bot", - "version": "1.1.1", + "name": "qq-official-bot", + "version": "0.0.1", "description": "qq机器人开发SDK", "main": "lib/index.js", "engines": { @@ -25,7 +25,7 @@ "README.md" ], "repository": { - "url": "https://github.com/lc-cn/qq-group-bot.git", + "url": "https://github.com/zhinjs/qq-official-bot.git", "type": "git" }, "keywords": [