Skip to content

配置文件

  • 在项目初始化完成后,项目根目录会生成一个名为zhin.yaml的文件,该文件为zhin核 心配置文件,内容大致如下。现在,让我们来了解下配置文件每一项的意义
yaml
adapters:
  icqq:
    bots:
      - self_id: 147258369
        platform: 5
plugins:
  config: null
  daemon: null
  help: null
  login: null
  systemInfo: null
  plugin: null
  watcher: plugins
log_level: info
plugin_dir: plugins
data_dir: data
delay:
  prompt: 60000

adapters

  • 存放适配器的配置文件,每一个key对应一个适配器,每一个适配器可以启动多个机器 人,每个机器人的配置存在bots
  • 不同适配器的机器人配置不尽相同,zhin在每一个bot配置基础上增加了一些zhin专有的 配置项,大致含义如下:

bot通用配置项

参数名参数类型默认值描述
self_idstring|number-必填参数 当前机器人唯一表示
masterstring | number-主人账号
admins(string | number)[][]管理员账号列表
prefixstring-指令调用前缀
text_limitnumber100消息长度限制,发送消息时超出该长度将自动转发
rate_limitnumber1000指令调用频率限制,单位毫秒
quote_selfbooleanfalse触发指令时,是否自动引用触发消息
enableboolean-当前机器人是否启用
enable_pluginsstirng[]-启用的插件列表
disable_pluginsstring[]-禁用的插件列表

TIP

适配器需安装后方能使用,(icqq为内置适配器,无需安装,相应配置请查 看adapter-icqq)

plugins

  • 存放插件的配置文件,每一个key对应一个插件,只有在此处定义的插件才会被加载到 zhin中

TIP

插件需安装后方能使用,(样例配置文件中的插件均为内置插件,无需安装即可使 用,相应配置请查看内置插件)

log_level

  • 日志输出等级:(可选值:off,debug,error,warn,info,all

plugin_dir

  • 本地插件存放文件夹路径

data_dir

  • 缓存数据文件存放文件夹路径

delay

  • 各种超时时长配置(单位:毫秒)