跳至主要內容

配置文件说明


配置文件说明

此处为各个配置文件的相关注释

overflow.json

默认值注释
connections[...]Onebot 实例连接配置
no_platformfalse是否禁止 Overflow 调用需要账号凭证的网络接口,如获取分享Key、群活跃等。在非QQ平台无法获取账号凭证的平台 (如 Gensokyo) 使用 Overflow 请开启该选项
use_cq_codefalse发送消息时,是否使用 CQ 码格式
retry_times5正向WS断开连接后重连尝试次数,设为 -1 禁用自动重连
retry_wait_mills5000每次重连之间的间隔时间 (毫秒)
retry_rest_mills60000重连次数用完后,等待多长时间 (毫秒) 后,重置次数再进行重连。设为 -1 禁用此功能
heartbeat_check_seconds60WebSocket 心跳策略检查时间 (秒),设为 0 关闭心跳策略
resource_cache-媒体消息(图片、语音、短视频)自动下载缓存配置,更详细的信息请见下方
drop_events_before_connectedtrue是否抛弃所有在Bot成功连接之前传入的事件。比如 go-cqhttp 会在连接之后,在 Overflow 获取到 Bot 信息之前,推送以前未收到的消息。如果开启此项,则丢弃这些消息

resource_cache

默认值注释
enabledfalse是否启用媒体消息自动下载缓存功能
keep_duration_hours168媒体缓存文件保留时间,超时自动删除,默认7天

connections

连接配置列表,单个连接的基本格式如下

默认值注释
enablefalse是否启用这个连接配置
type-连接类型
no_platform与根配置相同与根配置相同
use_cq_code与根配置相同与根配置相同
retry_times与根配置相同与根配置相同
retry_wait_mills与根配置相同与根配置相同
retry_rest_mills与根配置相同与根配置相同
heartbeat_check_seconds与根配置相同与根配置相同
drop_events_before_connected与根配置相同与根配置相同

正向 WebSocket

type 的值为 websocket 时,该连接配置是一个正向 WebSocket 配置,额外有以下配置可用

示例值注释
host"ws://127.0.0.1:3001"连接到 Onebot 的地址,使得 Overflow 可连接到 Onebot 实现
token""鉴权所需的令牌,留空则不进行鉴权

反向 WebSocket

type 的值为 websocket-reverse 时,该连接配置是一个反向 WebSocket 配置,额外有以下配置可用

示例值注释
port3002反向 WebSocket 服务器的端口,使得 Onebot 实现可连接到 Overflow
token""鉴权所需的令牌,留空则不进行鉴权