Bot配置文件

公告

站点迁移啦~！

为什么迁移?

作为由我们官方维护的组件库，分散在各自的文档站点中的确有好处：它们可以各自维护自己所需的东西、互不干扰。

但是缺点也很明显：太过分散。

组件库与核心库之间的关系是比较紧密的，我们希望你能够在一个站点内就可以查阅或搜索到所有你想要得知的信息。

示例

{ "component": "simbot.kook", "ticket": { "clientId": "client ID", "token": "ws token" } }

{ "component": "simbot.kook", "ticket": { "clientId": "client ID", "token": "ws token" }, "config": { "isCompress": true, "syncPeriods": { "guild": { "syncPeriod": 180000, "batchDelay": 0 }, "clientEngineConfig": { "threadsCount": null, "pipelining": null }, "wsEngineConfig": { "threadsCount": null, "pipelining": null }, "timeout": { "connectTimeoutMillis": 5000, "requestTimeoutMillis": 5000, "socketTimeoutMillis": null }, "wsConnectTimeout": null, "isNormalEventProcessAsync": null } } }

属性描述

component

固定值 simbot.kook，必填，代表此配置文件为KOOK组件的。

ticket

对 bot 身份进行校验、访问 KOOK API 以及连接KOOK服务器进行事件订阅时所需的 bot 票据信息。

clientId: BOT的 Client ID。
token: BOT使用 websocket 模式进行连接的 token.

config

其他配置，可选。

isCompress

是否压缩数据。默认为 true。

syncPeriods

缓存对象信息的同步周期配置。

{
  "config": {
    "syncPeriods": {
      "guild": {
        "syncPeriod": 180000,
        "batchDelay": 0
      }
    }
  }
}

你也可以尝试直接禁用定时同步来观察数据是否会出现差错。

{
  "config": {
    "syncPeriods": {
      "guild": {
        "syncPeriod": 0,
        "batchDelay": 0
      }
    }
  }
}

在预期中，仅通过事件的通知就应满足对内部缓存的同步更新。因此我们希望可以在完全禁用定时同步的情况下依旧可以保证缓存数据的准确性。但是目前测试或反馈的数据仍然不足，我们无法完全预判禁用定时同步可能造成的后果或如果因此而产生缓存数据不准确的可能原因。

因此我们希望你在可控范围内更多的尝试禁用定时同步并在出现问题时及时反馈，这可以帮助我们完善内部的缓存机制。

感谢您的支持与贡献！

guild

对频道服务器进行同步的周期信息配置，单位毫秒。

guild.syncPeriod

对频道服务器进行同步的周期，单位毫秒，大于0时有效。目前服务器同步的同时会去同步此服务器下的所有频道列表与成员列表。

默认为 180000 ，即 180000毫秒 -> 180秒 -> 3分钟。

进行配置的时候需要注意考虑调用频率上限等相关问题。

guild.batchDelay

同步数据是分页分批次的同步。 batchDelay 配置每批次后进行挂起等待的时间，单位毫秒。可以通过调大此参数来减缓 API 的请求速率, 默认不等待。

配置此属性可一定程度上降低触发调用频率限制的风险。

clientEngineConfig & wsEngineConfig

clientEngineConfig 和 wsEngineConfig 两个配置项类型相同，顾名思义它们分别是针对 API client 和 ws 场景下使用的 HttpClient 实例的引擎（通用）配置项。

它们的配置项都与 Ktor 的 HttpClientEngineConfig 的配置相同，没有额外的含义。

threadsCount: Specifies network threads count advice.
更多参考 Ktor文档
pipelining: Enables HTTP pipelining advice.
更多参考 Ktor文档

timeout

BOT内进行API请求时候的超时时间配置。(基于 Ktor HttpTimeout)

connectTimeoutMillis: a time period required to process an HTTP call: from sending a request to receiving a response.
更多参考 Ktor HttpTimeout
requestTimeoutMillis: a time period in which a client should establish a connection with a server.
更多参考 Ktor HttpTimeout
socketTimeoutMillis: a maximum time of inactivity between two data packets when exchanging data with a server.
更多参考 Ktor HttpTimeout

wsConnectTimeout

ws连接超时时间，单位 ms 。默认为 6000 毫秒。

isNormalEventProcessAsync

ProcessorType.NORMAL 类型的事件处理器是否在异步中执行。默认为 true。当为 false 时, NORMAL 的表现效果将会与 PREPARE 基本类似。

Last modified: 07 August 2024