limangox/zhin

qq bot devel framework with oicq / icqq 基于oicq/icqq的一个QQ机器人开发框架

zhin

基于icqq的简约机器人框架

## 快速上手

1.安装脚手架

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

2. 使用cli指令zhin init [projectName]初始化项目

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

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

两者的区别 带项目名则新建目录作为项目目录，不带项目名则将当前目录作为项目目录

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

3. 使用cli指令zhin start启动项目

4. 更改插件配置

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

即使该插件没有配置，也需要配置其value为null，因为zhin是按配置文件加载插件的，未在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 NodeJS机器人生态圈的标杆，在zhin以及oitq开发过程中也多次参考其设计思路或使用了其中部分代码

提问

群里反馈