配置说明
LyOptimize 的配置文件为 config.yml,位于插件数据目录中。配置内容包括数据库连接、开关提示消息、强制消息屏蔽关键词和玩家可控消息屏蔽关键词。
配置文件
| 文件 | 用途 |
|---|---|
config.yml | 配置数据库、提示消息和消息屏蔽关键词 |
修改配置后,是否需要重启取决于配置项。mysql.enable 修改后必须重启服务器。
数据库配置
yaml
mysql:
enable: false
databasename: mc2
username: mc2
password: mc1234
port: 3306
ip: 127.0.0.1| 配置项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
mysql.enable | 布尔值 | false | 是否启用数据库存储。修改后需要重启服务器。 |
mysql.databasename | 字符串 | mc2 | 数据库名称。 |
mysql.username | 字符串 | mc2 | 数据库用户名。 |
mysql.password | 字符串 | mc1234 | 数据库密码。 |
mysql.port | 整数 | 3306 | 数据库端口。 |
mysql.ip | 字符串 | 127.0.0.1 | 数据库地址。 |
MySQL 前置要求
启用 MySQL 存储前,必须安装 LyMySQLCore,并确认 LyMySQLCore 已成功连接数据库。未安装、未加载或连接失败时,本插件依赖 MySQL 的数据读取、保存、同步和相关记录功能不会生效。
数据库用于保存玩家的屏蔽开关状态。
提示消息
提示消息位于 message 节点下。每个功能分别配置开启和关闭时发送给玩家的消息,支持使用配置文件中的颜色代码格式。
yaml
message:
hide-player: '&7[&e系统&7] &a已屏蔽§6其他玩家!'
show-player: '&7[&e系统&7] &a已显示§6其他玩家!'
hide-custom-message: '&7[&e系统&7] &a已屏蔽§6全局§a自定义消息!'
show-custom-message: '&7[&e系统&7] &a已启用§6全局§a自定义消息!'
hide-other-blizzard-particles: '&7[&e系统&7] &a已屏蔽§6其他§a特效粒子效果!'
show-other-blizzard-particles: '&7[&e系统&7] &a已启用§6其他§a特效粒子效果!'
hide-self-blizzard-particles: '&7[&e系统&7] &a已屏蔽§6自身§a特效粒子效果!'
show-self-blizzard-particles: '&7[&e系统&7] &a已启用§6自身§a特效粒子效果!'
hide-mob-blizzard-particles: '&7[&e系统&7] &a已屏蔽§6怪物§a特效粒子效果!'
show-mob-blizzard-particles: '&7[&e系统&7] &a已启用§6怪物§a特效粒子效果!'
hide-minecraft-particles: '&7[&e系统&7] &a已屏蔽§6全局§a原版粒子效果!'
show-minecraft-particles: '&7[&e系统§7] &a已启用§6全局§a原版粒子效果!'
hide-model: '&7[&e系统&7] &a已屏蔽§6全局§a模型显示!'
show-model: '&7[&e系统&7] &a已启用§6全局§a模型显示!'| 配置项 | 说明 |
|---|---|
message.hide-player | 玩家关闭其他玩家显示时发送的消息。 |
message.show-player | 玩家重新显示其他玩家时发送的消息。 |
message.hide-custom-message | 玩家屏蔽自定义消息时发送的消息。 |
message.show-custom-message | 玩家重新启用自定义消息时发送的消息。 |
message.hide-other-blizzard-particles | 玩家屏蔽其他对象暴雪粒子时发送的消息。 |
message.show-other-blizzard-particles | 玩家显示其他对象暴雪粒子时发送的消息。 |
message.hide-self-blizzard-particles | 玩家屏蔽自身暴雪粒子时发送的消息。 |
message.show-self-blizzard-particles | 玩家显示自身暴雪粒子时发送的消息。 |
message.hide-mob-blizzard-particles | 玩家屏蔽怪物暴雪粒子时发送的消息。 |
message.show-mob-blizzard-particles | 玩家显示怪物暴雪粒子时发送的消息。 |
message.hide-minecraft-particles | 玩家屏蔽原版粒子时发送的消息。 |
message.show-minecraft-particles | 玩家显示原版粒子时发送的消息。 |
message.hide-model | 玩家屏蔽模型显示时发送的消息。 |
message.show-model | 玩家重新显示模型时发送的消息。 |
强制消息屏蔽
hide-custom-message 用于配置强制屏蔽的自定义消息关键词。配置在此节点下的关键词不需要玩家手动开启开关,匹配后会直接屏蔽玩家收到的对应消息。
yaml
hide-custom-message:
- '这是一条关键词|这是第二个关键词|第三个'| 配置项 | 类型 | 说明 |
|---|---|---|
hide-custom-message | 字符串列表 | 强制屏蔽自定义消息的关键词列表。 |
消息内容使用 JSON 文本,而不是普通的颜色文本。配置关键词时,应填写能够稳定出现在消息 JSON 内容中的文本。
同一条列表项中的多个关键词可以使用 | 分隔。使用 | 时,需要该条消息同时匹配这些关键词才会触发屏蔽。
如果关键词无法匹配消息,可以尝试调整关键词内容。
玩家可控消息屏蔽
player-hide-custom-message 用于配置玩家可以自行控制的自定义消息屏蔽关键词。
yaml
player-hide-custom-message:
- '关键词1|关键词2|关键词3'| 配置项 | 类型 | 说明 |
|---|---|---|
player-hide-custom-message | 字符串列表 | 玩家开启自定义消息屏蔽后使用的关键词列表。 |
此节点的写法与 hide-custom-message 相同,但关键词只会在玩家开启对应屏蔽开关后生效。适合屏蔽全服公告、重复提示或特效提示等自定义消息。
配置中的变量
以下变量由配置文件注释列出,可用于显示玩家当前的屏蔽状态。变量需要通过 PlaceholderAPI 使用。
| 变量 | 返回内容 | 对应功能 |
|---|---|---|
%lo_obp% | §7屏蔽 或 §a显示 | 其他暴雪粒子是否屏蔽 |
%lo_sbp% | §7屏蔽 或 §a显示 | 自身暴雪粒子是否屏蔽 |
%lo_mbp% | §7屏蔽 或 §a显示 | 怪物暴雪粒子是否屏蔽 |
%lo_par% | §7屏蔽 或 §a显示 | 原版粒子是否屏蔽 |
%lo_model% | §7屏蔽 或 §a显示 | 模型是否屏蔽 |
%lo_message% | §7屏蔽 或 §a显示 | 自定义消息是否屏蔽 |
%lo_player% | §7屏蔽 或 §a显示 | 其他玩家是否屏蔽 |