开发文档
字数
696 字
阅读时间
3 分钟
温馨提示
本页较长，建议使用Ctrl + F搜索关键字查找内容、善用右边导航栏。
嗨嗨嗨，欢迎来到karin的开发文档，我们是一个开放、友好的社区，欢迎大家的加入~
框架开发
咕咕咕，框架开发文档正在路上，敬请期待~
插件开发
了解插件
有关插件的基本概念，可以查看维基百科自行了解，这里不再赘述。
在karin中，插件一共有3种基本类型，分别是: Npm插件、Git插件、App插件。
Npm插件
温馨提示
Npm插件通常是已经发布到npm仓库的插件，所以此类插件不支持热更新。
特征:
- 通过
pnpm安装 package.json中包含karin字段karin字段中可能包含ts-app字段，这是用于在TypeScript环境下热开发的字段
Git插件
温馨提示
Git插件通常托管在Github或Gitee上，在克隆插件时请注意自身网络环境。
特征:
- 处于
./plugins目录下是文件夹并包含package.json文件 - 通过
git克隆(非绝对) - 目录下存在
.git文件夹(非绝对) package.json中包含karin字段，不包含此字段仅会加载main入口文件- 还有最特殊的一种，处于开发阶段，在根目录的
package.json中包含karin字段
App插件
温馨提示
App插件通常是指单个js、ts文件，通常处于./plugins/karin-plugin-example目录下
特征:
- 通常是一个单文件
- 处于
./plugins目录下的不带package.json的文件夹中 - 默认支持
热更新，无论是生产环境还是开发环境
插件子类
温馨提示
插件子类是指插件的一种分类，通常是指插件的功能性质。
command插件: 处理消息事件accept插件: 处理通知、请求事件task插件: 构建定时任务handler插件: 约定事件处理button插件: QQBot专属，构建按钮use插件: 中间件plugin类插件: 消息插件类
插件规范
温馨提示
本节点内容较长，请点击下方链接查看详细内容。
如若正在开发，并且是第一次接触，请务必查看！！！