KiviBot 简介 #

KiviBot 是使用 TypeScript 语言编写的轻量、优雅、跨平台、开发者友好的 QQ 机器人框架。

框架提供了状态监控、插件管理、管理员机制、消息通知、请求处理功能，开箱即用。框架完全开源，可扩展性强，插件开发简单，核心底层协议使用 icqq<-oicq v2，API 众多，功能强大。另外，框架使用 node 驱动，得益于 node 及其高效的 v8 引擎，KiviBot 的性能可观。

本项目开发初衷在于提高群活跃氛围、方便群管理，仅供个人娱乐、学习和交流使用，不得将本项目用于任何非法用途。

为什么选择 KiviBot #

• 轻量：无需运行 UI，内存占用低。

• 高效：框架依赖少，执行效率高。

• 跨平台：Windows, Linux, Android 等都能运行。

• 多协议：支持安卓手机、安卓平板、iPad、安卓手表和 MacOS 协议。

• 注重体验：使用 QQ 消息 执行操作、启用或升级插件。

• 极速开发：学习门槛低，只需几行 JS/TS 代码就能编写插件。

• 开发者友好：插件支持热重载，拥有友好的 Kivi API。

三步安装：快速上手

插件示例 #

仅需编写少量 TypeScript 代码即可实现丰富功能，参考下面的 Demo。

import { definePlugin } from "kivibot";

export default definePlugin({
  name: "模版",
  version: "1.0.0",
  async setup(ctx) {
    // 处理群消息 这里的e是指event事件
    ctx.handle("message.group", (e) => {
      // 控制台打印字符串内容(两种方法 有差异)
      console.log(e.toString());
      console.log(e.raw_message);

      // 快速回复消息
      e.reply(e.raw_message);
    });
  },
});

详细 Bot API 说明请参阅 Bot API

留给用户的话 #

真正意义上的理想机器人，理应是功能足够强大，默默无闻的，在你需要的时候，又能以最高的效率及时给予你帮助，足够方便，还能偶尔带来趣味与欢乐，而不是一味的堆积菜单，搞一堆花里胡哨的插件或者功能，抛开太多无意义的功能不说，还不断的刷屏，就为了显得机器人有多么多的功能 —— Viki

Viki 说的对 —— Dogxi