kotori-bot

小鳥 · KotoriBot

快速搭建 使用指南 开发教程
接口文档

---

基于NodeJS+TypeScript的go-cqhttp的SDK和QQ机器人框架实现,相比于其它的go-cqhttp的NodeJS实现，Kotori-Bot的最大特点便是完全由纯TypeScript语言开发

Kotori是一个罗马字，在日语中是ことり(小鳥)的意思，该名字取自于Key公式游戏《Rewrite》及其衍生作品中的主要女性角色之一的神户小鸟(神戸（かんべ） 小鳥（ことり）)。

Blog

---

概要

kotori是一个快捷,轻便,跨平台的BOT框架,去繁化简只为打造一个重工具,轻娱乐的工具性BOT

变更日志

kotori支持的连接模式

• 正向 WebSocket
• 反向 WebSocket

kotori目前现已支持go-cqhttp提供的67种Api,19种Event,18种CQ Code

关于插件

插件中心

收集插件将不定期更新，你可以直接通过Pull Request的方式将你的插件加入(或更新时)到仓库并更新docs/PLUGINS.md中的插件列表信息

以下内容已不保证时效性

从源码里构建

如果你想将KotoriBot作为一个NPM包或者说node项目库来导入到你自己的项目使用搭建机器人的话，由于TS语言本身的原因，无法直接导入纯TypeScript项目，需要先构建一遍TS源码

npm run build

构建完成后的文件将生成在dist/文件下，但你无需顾忌这么多，直接引入即可

• TypeScript(.ts)

  import Kotori from 'kotori-bot';
  
  const Bot = new Kotori(
  	{
  		mode: 'WsReverse',
  		port: 8080,
  	},
  	(Event: any, Api: any) => {
  		/* ... */
  	},
  );
  Bot.create();
  

• JavaScript With CommonJS(.js .cjs)

  const Kotori = require('kotori-bot');
  const Bot = new Kotori(
  	{
  		mode: 'WsReverse',
  		port: 8080,
  	},
  	(Event, Api) => {
  		/* ... */
  	},
  );
  Bot.create();
  

• JavaScript With ESModule(.mjs)

  import Kotori from 'kotori-bot';
  //...
  

  该方式下运行不会读取项目下的配置文件，需在实例化时传入配置参数，详细说明参考

Changelog

0.7.8 (2023-09-10)

Features

• grouper plugin and favicon (3640024)