Skip to Content
文档🧩 插件文档

🧩 插件文档

插件 (plugin) 是 KiviBot 实现功能的必需品。

KiviBot 本身不提供任何应用性功能，所以需要通过安装插件来实现丰富的功能。

下面将教会你如何安装一个插件，并启用它。

🍃 插件使用

由于 KiviBot 当前版本 (kivibot@2.0.0-rc.1) 暂不支持通过框架直接安装插件。

所以需要手动下载 插件 ，并解压到/框架目录/plugins文件夹下面。

如果你已经看了 🥚 快速上手，应该已经了解到框架基础文件目录是这样子的：

    • .npmrc
    • app.js
    • kivi.config.toml
    • package-lock.json
    • package.json

框架各文件解释见 框架配置/框架文件

这里演示目录中的 plugins 目录下面共有三个插件，分别为demo demo1 demo2。 (demo 意为演示,展示的片段)

而每个插件文件夹下均有 index.ts 文件，这是插件的主入口，也就是必须包含的。(index 意为主页,主要)

接下来我们试着 添加下面这个插件 到 框架下，

import { definePlugin } from "kivibot";
 
export default definePlugin({
  name: "demo1",
  version: "1.0.0",
  async setup(ctx) {
    //改为自己的qq号
    ctx.bot.sendPrivateMsg(114514, "demo1插件被启用了！");
  },
});

1️⃣ 首先在 plugins 目录下新建 demo1 文件夹。

(请注意，这里的文件夹名称要和index.ts 中导出的 name 相同，如果要更改目录名请同时修改 name 属性)

2️⃣ 然后 在 plugins/demo1 下新建 index.ts 文件。

3️⃣ 将上面代码复制到 index.ts 文件中并保存。

4️⃣ 通过 QQ消息 启用 demo1 插件 (需为主人)。基础消息命令见 框架配置/框架命令

#插件 重载 <插件名>
 
#插件 启用 demo1

plugin-on

💡
Tip

启用插件 默认并不需要重启进程，可以直接启用或者进行重载！#插件 重载 <插件名>

如果插件需要安装 额外的 npm 包 (模块)，则必须安装模块后，重启进程。

请避免频繁重启进程，这可能会引起登陆频繁等问题，见常见问题

✅ 很好，你已经启用了第一个插件！

🐾 接下来可以：

Last updated on
Android📋 插件列表