Skip to content

配置详解 ​

注意 ​

此配置详解并未完善,部分配置可能没有详细的解释。完整配置请前往:

相关内容

配置模板

预备知识 ​

koipy 的配置文件名为 config.yaml,需要你在首次搭建 Bot 时自主创建。YAML 是一种人类可读的文本格式。如果你需要让 Bot 做一些个性化设置,比如修改绘图配色、更改 bot 行为等,就需要修改 config.yaml,它有一定语法要求,详情请参阅:

https://zh.wikipedia.org/wiki/YAML

接下来就是各种配置项的功能作用说明。

你可以在配置模板页查看 koipy 支持的所有配置。它们都有简要说明和默认值。

编辑器 ​

善用编辑器,例如 VS Code,它可以帮助你更方便地格式化配置文件。

koipy 配置相关细节 ​

koipy 内部自主设计了一套反序列化和序列化模块,以更好地适配项目架构。

等效配置 ​

对于以下两个配置,在被 koipy 加载到程序内部时是等效的:

yaml
log-level: INFO
log_level: INFO

原因是koipy内部将这两者进行了合并,以便统一命名。

加载顺序 ​

koipy 启动时按以下顺序寻找配置文件,直到找到第一个就停止:

text
config.yaml
config.yaml.backup
config.yml

如果三个都不存在,但环境变量里提供了 KOIPY_LICENSE 与 KOIPY_BOT_TOKEN,程序会用这两个值构造一份最小配置。

报错处理策略 ​

配置解析失败时的行为是明确的,不会含糊过去:

  1. 启动阶段:如果配置文件存在但无法加载,程序会打印一条可读错误并直接退出,不会带着一份默认配置继续运行。
  2. 错误定位:解析错误会带上出错的位置,方便你直接定位到是哪一行写错了。
  3. 热重载阶段:/reload 失败时不会把错误的配置应用进去,当前生效的配置会保持原样。

序列化与类型标注 ​

版本v2.1.0 起,配置序列化模块支持现代的类型标注写法。这一项仍在测试中,如果你在改动配置后发现写入结果不符合预期,建议先备份再反馈。

注意

在通过 /set、面板或手工编辑改动配置之前,建议先备份一份 config.yaml。

文档内容同步自 koipy-public