Skip to content

内置插件

zhin 内置了7个插件,作为协助开发者管理 zhin 的基础,让我们来认识下这 七个葫芦娃

帮助(help)

用户使用 zhin 的 command 定义了指令,使用 help 可以获取对应帮助文本

功能描述

  • 1.聊天中输入 help 会获得到当前可用指令的帮助
  • 2.聊天中输入 help [pluginName:string] 可获取对应指令名的帮助文本

配置项

辅助登录 (login)

用户在登录 icqq 的过程中如果触发相关登录验证,可通过命令行完成验证

功能描述

  • 1.当触发 system.login.slider 事件时,可通过命令行输入对应 ticket
  • 2.当触发 system.login.qrcode 事件时,可在扫码后回车继续当前流程
  • 3.当触发 system.login.device 事件时,可通过命令行选择验证方式和接收验证方式参 数

配置项

配置文件管理 (config)

可通过聊天的形式更改 zhin 的配置文件

功能描述

  • 1.聊天中输入config 可以查看当前 zhin 的所有配置
  • 2.聊天中输入config <keyPath:string>可以查看当前 zhin 的对应 keyPath 的配置
  • 3.聊天中输入config -d <keyPath:stirng>可以删除当前 zhin 的对应 keyPath 的配置
  • 4.聊天中输入config <keyPath:string> <value>可以修改(没有则添加)当前 zhin 的对应keyPath的配置为对应值

配置项

插件管理(plugin)

可通过聊天的形式管理 zhin 的插件

功能描述

  • 1.聊天中输入plugin.list 可以查看当前 zhin 的所有插件
  • 2.聊天中输入plugin.detail <name:stirng>可以查看当前 zhin 的**对应名称的插件
  • 3.聊天中输入plugin.mount <name:string>可以挂载指定名称的插件到zhin
  • 4.聊天中输入plugin.unmount <name:string>可以取消挂载 zhin 中指定名称的插件
  • 5.聊天中输入plugin.enable <name:string>可以启用指定名称的插件
  • 6.聊天中输入plugin.disable <name:string>可以禁用指定名称的插件

配置项

热更新(watcher)

提供 zhin 插件开发过程中热更新的功能

功能描述

  • 1.在插件代码变化是,自动重载对应插件
  • 2.在配置文件中添加或删除插件时,自动加载或取消加载对应插件

配置项

可传入一个文件夹地址作为监听目录,默认为项目文件夹,建议不要更改,否则可能会造成 第二个功能无法使用

进程守护(daemon)

提供 zhin 进程守护的能力和手动重启的能力

功能描述

  • 1.在意外意外中断时,自动重启 zhin
  • 2.在聊天中,可使用指定的命令重启 zhin

配置项

配置名值类型默认值描述
exitCommandstirng|booleantrue是否启用退出指令,传字符串时,则自定义退出指令,默认退出指令为exit
autoRestartbooleantrue是否自动重启

系统信息(systemInfo)

提供日志查看和状态查看指令

功能描述

  • 1.在聊天中,可使用logs [lines:number]查看 zhin 指定行数的日志,(默认为10行)
  • 2.在聊天中,可使用status查看 zhin 当前的运行状态

配置项