NcatBot 文档

外观

配置项

约 565 字大约 2 分钟

2025-02-08

本文介绍 NcatBot 的各个配置项和配置项的指定方式.

配置项列表

yaml
bt_uin: "123456" # 机器人 qq 号
root: "123456" # 超级管理员账号
token: "" # token, 默认为 ""(空字符串)
ws_uri: ws://127.0.0.1:3001 # websocket server 地址, 默认为 ws://127.0.0.1:3001(本机 3001 端口)
  • bot_uin: 就是 Bot QQ 号. 这个千万不能填错了喵~
  • root: root QQ 号, 具有超管权限, 一般填你的 QQ 大号.
  • ws_uri: NapCat WebSocket 地址. 一般不用改喵.
  • token: NapCat 服务器的 token. 一般也不用改喵.

需要改动 ws_uri 和 token 的情况是 使用远端 NapCat 接口.

在代码里指定配置项(推荐)

配置项的指定方式如下:

python
from ncatbot.utils.config import config

config.set_ws_uri("ws://127.0.0.1:3001")
config.set_bt_uin("123456")
config.set_root("123456")
config.set_token("your token")

通过文件指定配置项

注意

这个功能可能有 bug, 请使用第一种方式指定配置项.

也可以用文件来指定配置项, 用文件指定配置项时, 配置文件的后缀名必须为 yaml. 且任何一项均不能缺省.

你可以复制配置项列表保存到配置文件, 然后修改配置项的值.

python
from ncatbot.utils.config import config

config.load_config("path/to/config.yaml")

配置项缺省

如果配置项有缺省(在代码中指定配置项时只指定了一部分), 则缺省的部分会使用默认配置项, 默认配置项的值见配置项列表.

python

  • bt_uin (Bot QQ 号)必须填写.

  • root 超级管理员账号, 建议填写.

  • 上面的代码注释了 ws_uri 和 token, 也就是这两个项可以缺省, 此时将使用默认值.

指定配置项的时机

由于我们采用全局变量的方式来保存配置项, 所以无论使用哪种方式, 都只需要在代码里指定一次即可.

另外, 由于创建 bot 实例时将会使用配置项, 因此配置项指定应该放在创建 bot 实例之前.

版权归属：huan-yp

许可证：署名 4.0 国际 (CC-BY-4.0)

© 2025 NcatBot