YuChat 配置说明
YuChat 首次启动会在 plugins/YuChat/ 生成多份配置文件。插件升级时会按版本号合并缺失节点，正式服改配置前仍建议先备份。
文件结构
| 文件 | 作用 |
|---|---|
config.yml | 主配置：数据库、依赖加载、聊天格式、经济、昵称、显示同步、公告和声音。 |
messages.yml | 命令提示、购买反馈、输入提示、GUI 状态和错误消息。 |
gui.yml | 玩家 GUI 与管理员 GUI 的标题、按钮、材质、名称和 lore。 |
titles.yml | 内置称呼配置。 |
custom_titles.yml | 管理员 GUI 新建称呼保存位置。 |
effects.yml | 颜色、渐变、彩虹、闪烁、循环等文本效果。 |
libs/ | 运行时下载的数据库与连接池依赖。 |
runtime/ | 发布版解压出的隔离 core jar。 |
library
| 节点 | 默认值 | 说明 |
|---|---|---|
library.enabled | true | 是否启用运行时依赖解析。关闭后只使用服务端或插件包中已有依赖。 |
library.verify-checksum | true | 是否校验依赖完整性。 |
library.fail-on-required-missing | true | 必需依赖缺失时是否中止启动。当前依赖均按可恢复依赖处理。 |
library.connect-timeout-ms | 15000 | 下载连接超时。 |
library.read-timeout-ms | 60000 | 下载读取超时。 |
storage
| 节点 | 默认值 | 说明 |
|---|---|---|
storage.type | sqlite | sqlite 或 mysql。 |
storage.table-prefix | yuchat_ | 所有数据表统一前缀。 |
storage.pool.enabled | true | MySQL 推荐开启；SQLite 会自动使用单写连接降低 locked 风险。 |
storage.mysql.* | 本地数据库示例 | MySQL 主机、端口、库名、账号、密码和 JDBC 参数。 |
storage.sqlite.file | yuchat.db | SQLite 数据库文件名。 |
placeholder
| 节点 | 默认值 | 说明 |
|---|---|---|
placeholder.enabled | true | 是否允许解析 PlaceholderAPI。 |
placeholder.expansion.enabled | true | 是否注册 YuChat 自带 %yuchat_*% 变量。 |
常见变量见 PlaceholderAPI。
prefix-suffix
prefix-suffix 控制 LuckPerms 前缀、后缀和 meta 的组合方式。
| 节点 | 说明 |
|---|---|
prefix-suffix.enabled | 是否启用前后缀读取与显示。 |
prefix-suffix.empty-text | GUI 中无前缀/后缀时显示的文字。 |
prefix-suffix.placeholder-fallback | LuckPerms API 不可用时是否使用 PlaceholderAPI 兜底。 |
prefix-suffix.prefix.parts | 前缀拼接片段，支持 prefix、all-prefixes、meta:<key>、text:<文本>、placeholder:<变量>。 |
prefix-suffix.suffix.parts | 后缀拼接片段。 |
prefix-suffix.meta-keys | 管理员 GUI 中常用 meta key 列表。 |
chat-format
聊天格式是 YuChat 的核心配置。
| 节点 | 说明 |
|---|---|
chat-format.enabled | 是否接管玩家聊天格式。 |
chat-format.format | 有称呼时的聊天格式。 |
chat-format.no-title-format | 无称呼时的聊天格式。 |
chat-format.parse-placeholderapi | 是否在聊天格式中解析 PlaceholderAPI。 |
chat-format.message-color.enabled | 是否处理聊天内容颜色。 |
chat-format.message-color.legacy-permission | 允许 & / § 颜色码的权限，默认 yuchat.chat.color。 |
chat-format.message-color.minimessage-permission | 允许 MiniMessage 标签的权限，默认 yuchat.chat.minimessage。 |
chat-format.message-color.hex-permission | 允许 Hex 颜色的权限，默认 yuchat.chat.hex。 |
chat-format.message-color.placeholder-permission | 允许聊天内容解析 PAPI 的权限，默认 yuchat.chat.placeholder。 |
component-broadcast 与悬浮
默认配置优先兼容 Bukkit 原始 AsyncPlayerChatEvent。
| 节点 | 建议 |
|---|---|
chat-format.component-broadcast.enabled | 需要聊天内 TextComponent 悬浮时再设为 true。 |
chat-format.hover.enabled | 悬浮总开关。 |
chat-format.hover.message | 聊天内容悬浮，最容易影响群组互联和聊天记录插件。 |
chat-format.hover.prefix | 前缀悬浮。 |
chat-format.hover.suffix | 后缀悬浮。 |
chat-format.hover.nickname | 昵称悬浮。 |
chat-format.hover.title | 称呼悬浮。 |
只有 component-broadcast.enabled、hover.enabled 和至少一个细分悬浮开关同时开启时，YuChat 才会取消原聊天事件并自行广播 TextComponent。
economy
经济节点可控制昵称、昵称颜色、昵称格式、消息颜色、个性签名、死亡消息和称呼的付费方式。
| 支付模式 | 说明 |
|---|---|
none | 免费。 |
vault | 使用 Vault 经济。 |
playerpoints | 使用 PlayerPoints 点券。 |
both | Vault 与 PlayerPoints 都扣除。 |
either | 两者二选一，优先按玩家余额可支付的一侧执行。 |
常见字段：
| 字段 | 说明 |
|---|---|
enabled | 是否启用该消费项。 |
mode | 支付模式。 |
vault-cost | Vault 金额。 |
points-cost | PlayerPoints 点券数量。 |
duration-seconds | 使用时长，0 表示永久。 |
nickname 与 signature
| 节点 | 说明 |
|---|---|
nickname.permission | 修改昵称所需权限，默认 yuchat.nickname.use。 |
nickname.change-permission | 允许变更昵称的权限，默认 yuchat.nickname.change。 |
nickname.input-color-permission | 允许普通输入中携带颜色的权限，默认 yuchat.nickname.input-color。 |
nickname.max-length | 昵称最大长度。 |
nickname.cooldown-seconds | 修改冷却。 |
nickname.blacklist | 昵称黑名单。 |
signature.max-length | 个性签名最大长度。 |
display
display 控制聊天以外的展示同步。
| 功能 | 说明 |
|---|---|
display.parse-placeholderapi | TAB、头顶名、Bukkit displayName 等显示格式是否解析 PAPI。 |
display.tab | 同步玩家列表名。若 TAB 插件接管，推荐在 TAB 插件里使用 %yuchat_tab%。 |
display.bukkit-display-name | 同步 Bukkit displayName，供部分插件读取。 |
display.nameplate | 控制头顶名，可使用 scoreboard-team 或 hologram 模式。 |
display.join-message | 加入消息格式与悬浮。 |
display.quit-message | 退出消息格式与悬浮。 |
display.death-message | 死亡消息、自定义死亡格式、击杀者解析和生物中文名。 |
titles.yml
每个称呼包含以下常用字段：
| 字段 | 说明 |
|---|---|
enabled | 是否启用。 |
display-name | GUI 展示名。 |
raw-text | 原始称呼文本。 |
format | 聊天中显示的格式。 |
permission | 权限拥有即视为已解锁。 |
temporary | 是否默认限时。 |
payment | 称呼购买费用。 |
effects.allowed | 允许该称呼使用的颜色效果 ID。 |
effects.default | 默认颜色效果。 |
icon | GUI 图标。 |
hover.lines | 聊天中称呼悬浮文本。 |
effects.yml
effects.yml 内置多种效果：基础颜色、渐变、彩虹、闪烁、脉冲、循环等。低版本客户端会自动降级为 legacy 颜色，1.16+ 可显示 Hex 与渐变效果。
reload
执行 /yc reload 后会重载配置、消息、GUI、称呼和效果文件。若 reload.gui.reopen-main-after-reload 为 true，正在查看 YuChat GUI 的玩家会被关闭旧界面并重开主界面，以便立即看到最新 gui.yml。