QQ Guild Sdk

指南

这里是 qq-guild-sdk 的一个简易指南，会在接下来的部分为你介绍一些如何开发属于你自己的机器人。

介绍

该 SDK 为 QQ 频道非官方 SDK，提供了一个简单的指南，以便您快速了解 SDK 的使用方法。 使用 TypeScript 编写，monorepo 架构。

特点

  • 使用 TypeScript 开发，支持类型检查和自动提示。
  • 使用 cli 快速构建项目，支持自定义配置。
  • 使用 Proxy 支持了一套 RESTFUL 风格的 api 调用方式，使官方 api 调用方面快捷，能很轻松的自定义扩展自己需要的接口。

快速上手

下面将指导如何快速上手，并且介绍一些常用的接口。

安装

  • 使用 cli
yarn create qq-guild-bot 你的机器人名字
1
  • 自主安装
mkdir 你的机器人名字
cd 你的机器人名字
yarn
yarn install qq-guild-sdk
1
2
3
4

编写你的第一段代码

使用 cli 的话这部分代码已经生成，这部分用户可直接阅读下方文档。

  • src/index.js
import { createBot } from 'qq-guild-sdk'

// 创建一个 bot
const bot = createBot({
  app: {
    // 集成了 dotenv 模块，可以自动读取环境变量
    id: process.env.id,
    key: process.env.key,
    token: process.env.token
  }
})
1
2
3
4
5
6
7
8
9
10
11

启动 wss 监听频道信息

  • src/index.js 在上一步的后面添加
async function main() {
  // 启动 wss 连接服务，并设置本次连接权限
  await bot.startClient(Bot.Intents.AT_MESSAGE | Bot.Intents.GUILDS)
  bot.on('ready', () => {
    console.log('Bot is ready.')
  })
  bot.on('message', async msg => {
    console.log('received message:', msg.content)
  })
}
// 捕获异常
main().catch(err => {
  console.error(err)
  process.exit(1)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

接收并回复指定消息

ping pong

  • src/index.js
async function main() {
  // 启动 wss 连接服务，并设置本次连接权限
  await bot.startClient(Bot.Intents.AT_MESSAGE | Bot.Intents.GUILDS)
  bot.on('ready', () => {
    console.log('Bot is ready.')
  })
  bot.on('message', async msg => {
    console.log('received message:', msg.content)
    if (msg.content === 'ping') {
      await bot.send.channel.reply(msg.id, msg.channelId, 'pong')
    }
  })
}
// 捕获异常
main().catch(err => {
  console.error(err)
  process.exit(1)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

常见问题