Zhin

面向 Node.js 开发者的聊天机器人框架，基于 oicq/icqq。

快速上手

1.安装脚手架

npm install -g @zhinjs/cli
# or 二选一即可
npm install @zhinjs/cli && npm link @zhinjs/cli

2. 初始化项目

选择一个本地文件夹作为项目目录执行 zhin init

或直接在想要建立项目的目录执行 zhin init <projectName>

两者的区别:

• 带项目名则新建目录作为项目目录
• 不带项目名则将当前目录作为项目目录

根据提示完成 Zhin 初始化操作

3. 启动项目

使用 cli 指令 zhin start 启动项目

4. 更改插件配置

启动完成后，默认只启用了help,daemon,watcher插件若你在初始化时选择了安装其他官方插件，请打开项目根目录下的zhin.yaml 按照配置文件中的plugins字段增加配置，其中key为插件名，对应value为配置，知音会自动加载对应插件

Zhin 会默认自动加载扫描到的所有插件，如果需要不加载某个插件，可在对应 Bot 的 Config 声明 disable_plugins。

5.编写插件

请先根据 cli 文档 使用 zhin new <pluginName> 新建一个插件，并更改模板中的初始代码后，重复第四步，添加该插件的配置插件添加后 在插件更改时，Zhin 将会自动重载该插件，无需重启项目

使用协议

Zhin 使用 MIT 协议开源

Copyright © 2019-2023, lc-cn

鸣谢

1. oitq (Zhin 前身，也是借鉴了 Koishi，因代码过于混乱，且名称与 oicq 过于相似，容易混淆，所以舍弃)
2. icqq (Zhin 作者维护的 oicq 一个分支) 提供 Zhin 内置适配器基础功能
3. Koishi Node.js 机器人生态圈的标杆，在 Zhin 以及 oitq 开发过程中也多次参考其设计思路或使用了其中部分代码

反馈