LogoArcartX Doc

基础配置

授权、聊天、速率、弹幕、TPA 与数据库设置

基础配置

文件说明

文件用途重载生效
license.yml许可证 ID 与密钥否
config.yml代理模式、消息、内容检测、速率、提示音、物品、弹幕和 TPA是
channels.ymlChorus 配置持有的频道、排序、图标、范围、权限和格式是
database.ymlSQLite、MySQL 与连接池否
language.yml语言文件是
player-actions.yml玩家操作菜单动作是
card/*.ymlArcartX 聊天卡片是
ui/*.ymlChorus 的三个 UI是

存在错误时,Chorus 会继续使用上一份有效设置

授权

首次启动生成:

licenseId: 你的许可证ID
licenseKey: "你的许可证密钥"

修改 license.yml 后必须完整重启。

config.yml

配置项默认值说明
proxy.enabledfalse是否使用 BungeeCord 或 Velocity;开启时数据库必须为 MySQL
default-channelpublic玩家没有可用已选频道时使用的频道
message-max-length256普通聊天、私聊和弹幕长度,范围 1..4096
moderation.actionBLOCKBLOCK 拒绝内容,SANITIZE 使用 Redact 替换结果
rate-limit.capacity4.0玩家频率限速总容量
rate-limit.refill-per-second0.75每秒恢复量
rate-limit.public-cost1.0普通频道消息消耗
rate-limit.private-cost1.0私聊消耗
rate-limit.card-cost2.0手持物品卡片消耗
rate-limit.danmaku-cost2.0弹幕速率消耗
mention.enabledtrue是否启用 @ 提示音
mention.soundchorus/sound/at.ogg客户端声音资源路径
mention.categorymaster声音分类
mention.pitch1播放音调
mention.keep-time5000声音保持时间,单位毫秒
held-item.cost.enabledfalse是否对物品展示收费
held-item.cost.providerVaultArcartX 中注册的经济提供者名称
held-item.cost.amount0.0展示价格,开启收费时必须大于 0
held-item.delivery.byte-budget-per-tick131072每个节点共享的单 Tick 字节预算,范围 16384..4194304
held-item.delivery.maximum-recipients-per-tick64每个节点单 Tick 最大接收者数,范围 1..512
danmaku.charge-per-message1每条弹幕消耗的发射器数量
danmaku.maximum-balance1000000弹幕余额上限
danmaku.duration-millis12000弹幕移动时间,范围 1000..60000
tpa.request-expire-seconds30请求有效期,范围 5..300
tpa.request-limit.window-seconds30请求限次统计窗口,范围 1..3600
tpa.request-limit.maximum3统计窗口内最多请求数,范围 1..100
tpa.teleport-delay-seconds3接受后的等待时间,范围 0..300
tpa.teleport-cooldown-seconds60传送冷却,范围 0..86400
tpa.cross-server.denied-servers[dungeon]禁止跨服 TPA 的子服名

各项 rate-limit.*-cost 必须大于 0,且不能超过 capacity。开启代理后,Bukkit 与代理(BC/VC)各自执行一层速率限制。

代理端也会生成 plugins/Chorus/config.yml,其中只有 tpa 配置。跨服部署时,两端的 TPA 有效期、请求限次、等待时间、冷却和禁用子服列表应保持一致;denied-servers 填代理配置中的子服名称。

database.yml

type: "sqlite"
sqlite-file: "chorus.db"
worker-threads: 4
 
mysql:
  host: "127.0.0.1"
  port: 3306
  database: "arcartx"
  username: "root"
  password: "change-me"
  parameters: "useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true"
  pool-size: 8
  • type 只接受 SQLITE 或 MYSQL;
  • sqlite-file 只能是 Chorus 数据目录中的单个文件名;
  • worker-threads 范围为 1..32;SQLite 固定使用单工作线程;
  • MySQL 端口范围为 1..65535,pool-size 范围为 2..50;
  • parameters 不要添加开头的 ?;
  • 数据库连接配置变化后必须完整重启。

数据库用于保存私聊屏蔽关系和弹幕余额。

代理(BC/VC)模式下所有 Bukkit 节点必须连接同一套 MySQL。使用 SQLite 会导致插件拒绝启动,避免玩家换服后出现余额或屏蔽状态不一致。

On this page