基于napcat,node-napcat-ts的bot框架
npm install xinc!Xinc
Xinc 是一个基于 NapCat 和 node-napcat-ts 的轻量级 QQ 机器人框架,专注于易用性和可扩展性。通过简单的插件系统,你可以快速构建自己的 QQ 机器人功能。
bash
mkdir my-xinc-bot
cd my-xinc-bot
npm install xinc
npx xinc init
`
2. 启动框架
`bash
直接启动
npx xinc start
或者使用 PM2 在后台运行
npx xinc start --pm2
`🚀 快速开始
初始化项目后,框架会自动创建一个示例插件。
你可以通过以下命令创建自己的插件:
`bash
npx xinc new 插件名称
`
启动框架后,你可以在 QQ 中发送命令与机器人交互:
- #帮助 - 显示帮助信息
- #状态 - 查看框架状态
- #插件 列表 - 查看插件列表🔌 插件开发
Xinc 提供了简单直观的插件 API,以下是一个基本插件示例:
`typescript
import { definePlugin, Structs } from 'xinc'export default definePlugin({
name: '你好世界',
version: '1.0.0',
desc: '一个简单的示例插件',
setup(ctx) {
// 处理消息
ctx.handle('message', async e => {
if (e.raw_message === '你好') {
e.reply('世界,你好!')
}
})
// 记录插件加载信息
ctx.logger.info('插件已加载')
}
})
`$3
API插件上下文 ctx 提供了丰富的 API:
- 消息处理:handle, reply, sendPrivateMsg, sendGroupMsg
- 信息获取:getText, getImageURL, getAtUserID, getGroupList
- 权限控制:isRoot, isAdmin, isGroupAdmin
- 群管理:setGroupBan, setGroupKick, setGroupCard📋 命令列表
$3
- #状态 - 查看框架状态
- #帮助 - 显示帮助信息
- #退出 - 关闭框架(仅限主人)$3
- #插件 列表 - 查看插件列表
- #插件 启用 <插件名> - 启用指定插件
- #插件 禁用 <插件名> - 禁用指定插件
- #插件 重载 <插件名> - 重载指定插件$3
- #设置 加管理 - 添加框架管理员
- #设置 删管理 - 删除框架管理员
- #设置 加主人 - 添加框架主人
- #设置 删主人 - 删除框架主人
- #设置 前缀 <前缀> - 修改命令前缀
- #设置 日志 <级别> - 修改日志级别📄 配置文件配置文件
xinc.config.toml 包含以下内容:
`toml
host = "127.0.0.1"
port = 5700
prefix = "#"
root = [12345678]
admins = []
plugins = ["你好世界"]
logger = "info"
``API 实现---Made with ❤️ by 勿忘初心