mizuki-sdk
v1.0.0
Published
A plugin-in qq bot sdk
Downloads
13
Readme
mizuki-sdk
基于腾讯官方typescript sdk 的改版qb-sdk实现的 NTQQ 接入框架。
⚠️ 本项目由于使用了装饰器特性,只支持使用 typescript 进行开发。
安装与使用
注册QQ开放平台机器人
安装与配置本项目
在你的项目文件夹中
# npm
npm install mizuki-sdk
# yarn
yarn add mizuki-sdk
修改 tsconfig.json
,开启装饰器
{
"compilerOptions": {
...
"experimentalDecorators": true,
...
}
}
开始你的第一个 hello world
我们新建一个main.ts
和 一个文件夹 plugins
,并在此文件夹新建一个index.ts
,和hello-world.ts
// main.ts
import { server, AvailableIntentsEventsEnum } from 'mizuki-sdk'
import './plugins/index.ts'
const config = {
appID: '<your appID>',
token: '<your token>',
intents: [AvailableIntentsEventsEnum.GROUP_AND_C2C_EVENT],
sandbox: true,
}
await server.run(config)
// plugins/index.ts
export * from './hello-world'
// plugins/hello-world.ts
import { mapper, plugins, GroupContext, MessageType } from 'mizuki-sdk'
@plugins.register('hello-world')
export class HelloWorld {
@mapper.onGroupAt()
async helloWorld(groupContext: GroupContext) {
await groupContext.post(groupContext.data.msg.group_openid, {
msg_type: MessageType.TEXT,
msg_id: groupContext.data.msg.id,
content: 'hello world',
})
}
}
如果你想要自定义响应指令,可以通过onGroupAt
中的options
字段中的command
设置,除此之外
,你还可以通过priority
和block
设置事件响应器优先级和是否阻塞
⚠️ 为了适配QQ官方的指令配置,默认响应指令头为
\
,也就是说,如果你设置command: 'hello'
,则需通过/hello
触发
// plugins/hello.ts
import { mapper, plugins, GroupContext } from 'mizuki-sdk'
@plugins.register('hello')
export class Hello {
@mapper.onGroupAt({ command: 'hello' })
async hello(groupContext: GroupContext) {
await groupContext.post(groupContext.data.msg.group_openid, {
msg_type: MessageType.TEXT,
msg_id: groupContext.data.msg.id,
content: 'hello',
})
}
}
// ⚠️ 注意别忘了在plugin/index.ts中添加导出语句
如果你还想为server配置更多选项,目前提供了日志等级设置和启用内建插件功能,你可以将main.ts
中对server
的调用更改为:
// main.ts
await server
.setLogLevel('info')
.useBuiltinPlugins(['echo', 'get_message_data'])
.run(config)