kaiheila.ts

一个使用 typescript 编写的开黑啦机器人框架

开发进度

• [x] ~~服务器相关接口~~
• [x] ~~频道相关接口~~
• [x] ~~频道消息相关接口~~
• [x] ~~私聊会话接口~~
• [x] ~~Gateway相关接口~~
• [x] ~~私聊消息相关接口~~
• [x] ~~用户相关接口~~
• [x] ~~媒体模块接口~~
• [x] ~~服务器角色相关接口~~
• [x] ~~亲密度相关接口~~
• [ ] 服务器表情相关接口
• [ ] 邀请相关接口
• [x] ~~卡片消息生成器~~
• [x] ~~插件模块~~
• [x] ~~频道相关事件~~
• [x] ~~私聊消息事件~~
• [x] ~~服务器成员相关事件~~
• [x] ~~服务器角色相关事件~~
• [x] ~~服务器相关事件~~
• [x] ~~消息相关事件~~
• [x] ~~用户相关事件~~
• [ ] 中间件功能

使用方法

使用cli

首先安装 kaiheila.ts

npm install khts

然后初始化一个配置文件

npx khts init

接下来按照下面的文档修改配置文件

修改完成后运行

npx khts start

启动机器人

手写代码

import App from 'khts'

const bot = new App({
  // 配置写这里
})

bot.plugin.load('xxx') // 手动加载插件 (注：此方法加载插件将会无法使用配置文件，推荐把插件直接卸载配置里面)
bot.client // 访问Bot实例

配置文件

{
  "bot": {
    "token": "机器人的token"
  },
  "logger": {
    "level": "日志级别"
  },
  "plugins": {
    // 你要引用的插件的文件名或者npm包的名字
    "./test.ts": {
      // 传递给插件的配置
    }
  }
}

插件开发

参考以下代码

import { ctx } from "./lib/plugin"; // 引入这个是为了代码提示

export default (ctx: ctx) => {
  ctx.logger.info(ctx.config) // 插件的配置文件在这里可以找到

  ctx.logger.info('xxx') // 这个是日志模块

  // 注册一个命令
  ctx.command(/^\/help$/, '/help', '查看帮助信息', (match, event, reply) => {
    // 命令被触发做的事情
    reply(1, 'xxx') // 快速回复
  })

  ctx.bot // Bot实例在这里
}

BUG反馈

• 直接提交 issue
• 开黑啦