Skip to content

Commit

Permalink
docs: enhance qqguild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shigma committed Dec 12, 2021
1 parent dca2868 commit 34f25b0
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 24 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,11 @@ Koishi 完全基于 TypeScript 开发,拥有顶级的类型支持,丰富的

### 平台支持

- [adapter-onebot](https://koishi.js.org/plugins/adapter/onebot.html): [OneBot](https://github.com/howmanybots/onebot) 协议支持,可用于 QQ
- [adapter-discord](https://koishi.js.org/plugins/adapter/discord.html): [Discord](https://discord.com/) 平台支持
- [adapter-telegram](https://koishi.js.org/plugins/adapter/telegram.html): [Telegram](https://telegram.org/) 平台支持
- [adapter-kaiheila](https://koishi.js.org/plugins/adapter/kaiheila.html): [开黑啦](https://kaiheila.cn/) 平台支持
- [adapter-onebot](https://koishi.js.org/plugins/adapter/onebot.html): [OneBot](https://github.com/howmanybots/onebot) 协议支持,可用于 QQ
- [adapter-qqguild](https://koishi.js.org/plugins/adapter/qqguild.html): QQ 频道平台支持
- [adapter-telegram](https://koishi.js.org/plugins/adapter/telegram.html): [Telegram](https://telegram.org/) 平台支持

### 静态资源存储

Expand Down
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ module.exports = {
'/plugins/adapter/discord.md',
'/plugins/adapter/kaiheila.md',
'/plugins/adapter/onebot.md',
'/plugins/adapter/qqguild.md',
'/plugins/adapter/telegram.md',
],
}, {
Expand Down
9 changes: 5 additions & 4 deletions docs/guide/introduction/coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ Koishi 需要 [NodeJS](https://nodejs.org/) (最低 v12,推荐使用 LTS) 运

Koishi 支持多个聊天平台,对于不同的平台,你也需要做好相应的准备工作。

- [接入 OneBot (QQ)](../../plugins/adapter/onebot.md)
- [接入 Discord](../../plugins/adapter/discord.md)
- [接入 Telegram](../../plugins/adapter/telegram.md)
- [接入开黑啦](../../plugins/adapter/kaiheila.md)
- [Discord](../../plugins/adapter/discord.md)
- [开黑啦](../../plugins/adapter/kaiheila.md)
- [OneBot](../../plugins/adapter/onebot.md)
- [QQ 频道](../../plugins/adapter/qqguild.md)
- [Telegram](../../plugins/adapter/telegram.md)

如果你还没有准备好对接到哪些平台,也不用着急,Koishi 可以在不对接任何平台的情况直接启动(只不过没有机器人你就无法进行交互了)。

Expand Down
9 changes: 5 additions & 4 deletions docs/guide/introduction/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ Koishi 需要 [NodeJS](https://nodejs.org/) (最低 v12,推荐使用 LTS) 运

Koishi 支持多个聊天平台,对于不同的平台,你也需要做好相应的准备工作。

- [接入 OneBot (QQ)](../../plugins/adapter/onebot.md)
- [接入 Discord](../../plugins/adapter/discord.md)
- [接入 Telegram](../../plugins/adapter/telegram.md)
- [接入开黑啦](../../plugins/adapter/kaiheila.md)
- [Discord](../../plugins/adapter/discord.md)
- [开黑啦](../../plugins/adapter/kaiheila.md)
- [OneBot](../../plugins/adapter/onebot.md)
- [QQ 频道](../../plugins/adapter/qqguild.md)
- [Telegram](../../plugins/adapter/telegram.md)

如果你还没有准备好对接到哪些平台,也不用着急,Koishi 可以在不对接任何平台的情况直接启动。

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/adapter/kaiheila.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 适配器:Kaiheila
title: 适配器:开黑啦
sidebarDepth: 2
---

Expand Down
22 changes: 10 additions & 12 deletions docs/plugins/adapter/qqguid.md → docs/plugins/adapter/qqguild.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@ sidebarDepth: 2

# @koishijs/plugin-adapter-qqguild

QQ 频道官方 SDK 适配器,基于 `@qq-guild-sdk/core` 实现。
## 接入方法

1. 前往 [QQ 频道管理后台](https://bot.q.qq.com/open/#/type?appType=2) 注册。
2. 登陆进入 [机器人管理后台](https://bot.q.qq.com/open/#/botlogin) 并创建官方机器人。
3. 创建完成后,在 [频道机器人开发设置](https://bot.q.qq.com/#/developer/developer-setting) 获取机器人基本数据 [id, token, key(secret)]
4. 将上面的基本数据作为机器人配置项即可使用。
QQ 频道官方 SDK 适配器,基于 [@qq-guild-sdk/core](https://www.npmjs.com/package/@qq-guild-sdk/core) 实现。

1. 前往 [QQ 频道管理后台](https://bot.q.qq.com/open/#/type?appType=2) 注册
2. 登陆进入 [机器人管理后台](https://bot.q.qq.com/open/#/botlogin) 并创建官方机器人
3. 创建完成后,在 [频道机器人开发设置](https://bot.q.qq.com/#/developer/developer-setting) 获取机器人基本数据 [id, token, key(secret)]
4. 将上面的基本数据作为机器人配置项即可使用

参考文档:<https://nwylzw.github.io/qq-guild-sdk/api>

## 适配器选项

Expand All @@ -37,15 +41,9 @@ QQ 频道官方 SDK 适配器,基于 `@qq-guild-sdk/core` 实现。

验证方式。

## bot 的内置属性

### bot.$innerBot

该属性为 `qq-guild-sdk``Bot` 实例。详细可参考 [qq-guild-sdk 文档](https://nwylzw.github.io/qq-guild-sdk/api)

## 常见问题

- Q: 如何申请测试频道?
- A: [申请测试频道问卷](https://docs.qq.com/form/page/DZVF3RFJnTGF0Y3Nk?_w_tencentdocx_form=1)
- Q: 如何申请测试(私域)频道不校验语料?
- Q: 如何申请测试 (私域) 频道不校验语料?
- A: [私域频道问卷](https://wj.qq.com/s2/9379748/ed13/)
2 changes: 1 addition & 1 deletion docs/plugins/adapter/telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebarDepth: 2
4. 使用 `/setprivacy` 开启 Privacy Mode(不然机器人只能收到特定消息)
5. 创建完毕后,你会获得一个 token(请注意不要泄露),将其作为机器人配置项即可使用

参考文档:[https://core.telegram.org/bots](https://core.telegram.org/bots)
参考文档:<https://core.telegram.org/bots>

## 机器人选项

Expand Down

0 comments on commit 34f25b0

Please sign in to comment.