ChatFormatter - Beautify your chat with hovers, clickable messages and more! - ChatFormatter - 美化聊天插件

ChatFormatter 是一款功能强大的聊天格式化插件，支持丰富的文本样式与交互功能，让服务器聊天体验焕然一新。它深度整合了 PlaceholderAPI 与 Vault，并提供了灵活的模板系统，方便管理员为不同玩家组别定制专属的聊天格式。

💡前置需求

此插件需要以下前置插件才能正常运行

• PlaceholderAPI
• Vault

[✨] 核心特性

• PlaceholderAPI 支持：可在格式中使用各种 PlaceholderAPI 变量。
• MiniMessages 支持：支持现代化的 MiniMessages 格式，并兼容传统的颜色代码（如 &c）。
• 模板系统：通过模板简化复杂格式的配置，保持配置文件整洁。
• 自定义占位符系统：允许你定义简短的占位符来代表更长的文本或样式组合。
• 按权限的 MiniMessages 标签：可为不同玩家权限组启用特定的颜色、渐变或交互标签。

🎮权限列表

每个颜色和样式权限（例如 chatformatter.color.white, chatformatter.decorations.bold）都同时授予玩家使用传统代码（如 &f, &l）和 MiniMessage 标签（如 <white>, <bold>）的能力。

样式与交互权限

• chatformatter.decorations.* - 所有装饰标签：<bold>, <italic>, <underlined>, <strikethrough>, <obfuscated> 及其对应的 & 代码。
• chatformatter.decorations.bold - <bold>, <b>, &l
• chatformatter.decorations.italic - <italic>, <i>, <em>, &o
• chatformatter.decorations.underlined - <underlined>, &n
• chatformatter.decorations.strikethrough - <strikethrough>, <st>, &m
• chatformatter.decorations.obfuscated - <obfuscated>, <obf>, &k
• chatformatter.reset - <reset>, &r
• chatformatter.newline - <newline>, <br>
• chatformatter.shadow - <shadow>
• chatformatter.gradient - <gradient>
• chatformatter.rainbow - <rainbow>
• chatformatter.pride - <pride>
• chatformatter.transition - <transition>
• chatformatter.hover - <hover>
• chatformatter.click - <click>
• chatformatter.insertion - <insertion>

颜色权限

• chatformatter.color.* - 所有颜色代码，包括 <red>, <blue>, <#a568a9>, &c, &#a568a9 等。
• chatformatter.color.black - <black>, &0
• chatformatter.color.dark_blue - <dark_blue>, &1
• chatformatter.color.dark_green - <dark_green>, &2
• chatformatter.color.dark_aqua - <dark_aqua>, &3
• chatformatter.color.dark_red - <dark_red>, &4
• chatformatter.color.dark_purple - <dark_purple>, &5
• chatformatter.color.gold - <gold>, &6
• chatformatter.color.gray - <gray>, &7
• chatformatter.color.dark_gray - <dark_gray>, &8
• chatformatter.color.blue - <blue>, &9
• chatformatter.color.green - <green>, &a
• chatformatter.color.aqua - <aqua>, &b
• chatformatter.color.red - <red>, &c
• chatformatter.color.light_purple - <light_purple>, &d
• chatformatter.color.yellow - <yellow>, &e
• chatformatter.color.white - <white>, &f

其他组件权限

• chatformatter.score - <score>
• chatformatter.selector - <selector>
• chatformatter.font - <font>
• chatformatter.translatable - <lang>
• chatformatter.keybind - <key>
• chatformatter.nbt - <nbt>

功能权限

• chatformatter.reload - 允许使用 /chatformatter reload 命令重载插件。
• chatformatter.receiveupdates - 接收此插件的更新公告。

🔧配置文件详解 (`config.yml`)

配置文件允许你自定义聊天格式、占位符和模板。

基础设置

• receiveUpdates: true - 是否接收 ChatFormatter 新版本的更新通知。

聊天格式

• defaultFormat: "{displayname} » {message}" - 默认聊天格式。
• format: - 为不同权限组（Vault 中的组）设置不同的聊天格式。组名必须与权限插件中的配置完全一致。如果玩家拥有多个组，请正确设置组的权重。
• default: "{member} &7$hoverName({displayname}) &8» <gradient:#d4d4d4:white>{message} "
• vip: "{vip} &f$hoverName({displayname}) <dark_gray>» <gradient:#ffd270:white>{message}"
• mod: "{mod} &f$hoverName({displayname}) <dark_gray>» <gradient:#a3ff9e:white>{message}"
• admin: "{admin} &f$hoverName({displayname}) <dark_gray>» <gradient:#bac8ff:white><b>{message}"
• owner: "{owner} &f$hoverName({displayname}) <dark_gray>» <gradient:#ff9195:white><b>{message}"

自定义占位符

在 placeholders: 部分，你可以定义简短的占位符来代表更复杂的文本或样式，其中可以使用 PAPI 变量。

placeholders:
  {displayname}: "<displayname>"
  {name}: "<name>"
  {message}: "<message>"
  {member}: "<#6e6764>Member"
  {vip}: "<gold>VIP"
  {mod}: "<b><#00c900>Mod</b>"
  {admin}: "<b><#6e86ff>Admin</b>"
  {owner}: "<b><gradient:#c40000:#e04b4b>Owner</b>"
  {rankDescription}: "<dark_gray>Rank: <white>%vault_group%"
  {joinDate}: "<dark_gray>Joined: <white>%player_first_join_date%"
  {health}: "<dark_gray>Health: <red>%player_health%"
  {lvl}: "<dark_gray>LVL: <gold>%player_level%"
  {privateMessage}: "<gradient:#36ff39:#75ff75><i>Click to send private message</i></gradient>"

模板系统

templates: 部分适用于高级用户，用于进一步缩短文本，保持配置文件简洁。示例如下：

templates:
  - "$hoverName($name) -> '<hover:show_text:'<dark_gray>Name: <white>$name<br><br>{rankDescription}<br>{joinDate}<br>{health}<br>{lvl}<br><br>{privateMessage}'><click:suggest_command:'/msg {displayname}'>{displayname}</click></hover>'"

❓使用提示与链接

• MiniMessages 格式：推荐使用 Web UI 来辅助编写 MiniMessages 格式：https://webui.adventure.kyori.net/
• 格式文档：详细格式说明请查阅：https://docs.adventure.kyori.net/minimessage/format.html
• LuckPerms 占位符：关于 LuckPerms 的设置和占位符，请参考：https://luckperms.net/wiki/Placeholders

格式示例

• 悬停文本（单行）：<hover:show_text:'<red>test'>TEST
• 悬停文本（多行）：<hover:show_text:'<red>test'>Test<newline>Test2</hover>
• 点击事件（打开URL）：<click:open_url:'https://webui.adventure.kyori.net'>TEST</click>
• 点击事件（执行命令）：<click:run_command:/say hello>Click</click> to say hello
• 点击事件（建议命令）：<click:suggest_command:'/msg {displayname}'></click>
• RGB与渐变：
• <color:#ff00ee>Example message</color>
• <gradient:#ff00ee:#f79459>Example message</gradient>

内部占位符

你可以在格式中使用以下三个内部占位符

• <displayname>
• <name>
• <message>

简介

ChatFormatter 是一款功能强大的 Minecraft 聊天管理插件，它允许服务器管理员深度自定义聊天格式、颜色和功能。通过此插件，你可以为不同玩家组别设置独特的聊天样式，集成 PlaceholderAPI 来显示动态信息，并有效管理聊天环境，从而显著提升服务器的聊天体验和社区氛围。

💡主要特性

• 完全可定制的聊天格式：为不同的玩家组别（如管理员、VIP、普通玩家）设置不同的聊天前缀、后缀和消息颜色。
• PlaceholderAPI 集成：在聊天格式中使用 PlaceholderAPI 占位符，动态显示玩家的等级、金钱、在线时间等信息。
• 多语言支持：插件内置多语言系统，可轻松适配不同语言的玩家社区。
• 聊天管理功能：提供聊天清除、全局静音（聊天锁定）等实用管理命令。
• RGB 渐变颜色支持：允许在聊天中使用华丽的 RGB 渐变颜色代码（需要服务器支持）。
• 轻量且高效：代码经过优化，对服务器性能影响极小。
• 自动更新检查器：可配置的自动更新通知，帮助管理员及时获取新版本。

🎮命令与权限

管理员命令

• /chatformatter reload

- **描述**：重载插件的配置和语言文件。

- **权限**：`chatformatter.reload`

• /chatformatter clear

- **描述**：清除服务器聊天记录。

- **权限**：`chatformatter.clear`

• /chatformatter lock

- **描述**：锁定（静音）或解锁全服聊天。

- **权限**：`chatformatter.lock`

• /chatformatter help

- **描述**：显示插件帮助信息。

- **权限**：`chatformatter.help`

玩家命令

• /chatformatter

- **描述**：显示插件基本信息。

🔧安装与配置

前置需求

• 服务器核心：Spigot、Paper 或其衍生服务端（推荐 Paper 1.17+ 以获得最佳性能）。
• 可选依赖：PlaceholderAPI（若需在聊天格式中使用动态占位符）。

安装步骤

• 将下载的 ChatFormatter.jar 文件放入服务器的 plugins 文件夹。
• 重启服务器以生成默认配置文件和数据文件夹。
• 根据你的需求编辑 plugins/ChatFormatter/config.yml 和 plugins/ChatFormatter/formats.yml 文件。
• 如需重载配置，可在游戏内使用 /chatformatter reload 命令或在控制台输入 reload confirm。

基础配置指南

主要的自定义在 formats.yml 文件中进行。你可以为每个权限组定义聊天格式。

**格式示例**

default:
  format: '{PLAYER}: {MESSAGE}'
vip:
  format: '&a[VIP] {PLAYER}&7: &f{MESSAGE}'
  permission: 'chatformatter.group.vip'

• {PLAYER}： 将被替换为玩家名。
• {MESSAGE}： 将被替换为玩家发送的聊天消息。
• 你可以使用 & 符号后接颜色/格式代码（如 &a 代表绿色），或使用十六进制颜色代码（如 &#00FF00）。
• permission 字段用于指定使用此格式所需的权限节点。

✨常见问题 (FAQ)

• 问：如何让聊天显示玩家的等级和金钱？

- 答：你需要安装 PlaceholderAPI 及其对应的数据扩展插件（如 Vault 和某个等级插件）。然后在 `formats.yml` 的格式中使用相应的占位符，例如 `%vault_eco_balance%` 来显示金钱。

• 问：我更改了配置文件，但游戏内没有生效？

- 答：请确保在修改后保存文件，并使用 `/chatformatter reload` 命令重载插件配置。检查控制台是否有错误提示。

• 问：支持哪些颜色代码格式？

- 答：支持传统的 `&` 颜色代码（如 `&c`）、十六进制颜色代码（如 `&#FF0000`），并且在支持的服务端上（如 Paper 1.16+），还支持 RGB 渐变格式（如 `<#FF0000>红</#0000FF>蓝`）。

• 问：如何为不同世界设置不同的聊天格式？

- 答：当前版本默认不提供按世界区分的聊天格式。但你可以通过 PlaceholderAPI 的 `%world%` 占位符结合条件判断来实现类似效果，或寻找支持此功能的插件扩展。

⭐注意事项

• 在使用 RGB 或渐变颜色时，请确保你的服务器核心（如 Paper）支持这些特性，否则颜色可能无法正常显示。
• 重载配置（/chatformatter reload）在绝大多数情况下是安全的，但在服务器高负载时进行，可能导致极短暂的卡顿。
• 定期备份你的配置文件是一个好习惯，尤其是在进行重大格式修改之前。
• 插件的更新信息发布在官方资源页面和 GitHub 仓库，建议关注以获取新功能和错误修复。