Skip to content
目录

配置文件

每个 Koishi 应用都有一个配置文件,它管理了应用及其插件的全部配置。配置文件的格式为 YAML,它是一种易于阅读和编辑的文本格式,你可以用任何文本编辑器打开。

TIP

如果你不了解 YAML 的语法,请不要随意修改配置文件,否则将可能导致 Koishi 应用无法运行。你可以在这篇教程中学习 YAML 的语法。

根目录位置

配置文件所在的目录叫根目录。根据你的安装方式,根目录的位置可能不同:

  • zip: 解压目录下 data/instances/default
  • msi: C:/Users/你的用户名/AppData/Roaming/Koishi/Desktop/data/instances/default
  • pkg: ~/Library/Application Support/Koishi/Desktop/data/instances/default

配置文件是根目录下名为 koishi.yml 的文件。当你遇到问题时,开发者可能会要求你提供配置文件的内容。此时去上面的地方找就好了。

理解配置文件

尝试打开配置文件,你会发现它的内容大致如下:

yaml
# 全局设置
host: localhost
port: 5140

# 插件列表
plugins:
  # group 表示这是一个插件组
  group:basic:
    help:
    rate-limit:
    locales:
    commands:

  # 这是另一个插件组
  group:adapter:
    # 波浪线前缀表示一个不启用的插件
    ~adapter-onebot:
    ~adapter-discord:
    ~adapter-telegram:
    gocqhttp:

  # 你刚刚安装的 NovelAI 插件
  novelai:

你会发现,配置文件的结构与「插件配置」页面基本是一致的。当你启动 Koishi 应用时,Koishi 会读取上述配置文件并加载所需的插件;而当你在「插件配置」页面中修改了某些配置,Koishi 也会自动将这些改动写入配置文件。

绝大多数的功能都可以通过「插件配置」页面来完成,但目前尚有一些功能没有做好相应的交互界面,这时你就需要手动修改配置文件了。你需要做的有以下几步:

  1. 关闭当前 Koishi 应用
  2. 打开配置文件进行编辑
  3. 保存配置文件后再次启动 Koishi 应用