[MD]
# VelocityChat
**一款 Velocity 代理端跨服聊天插件**
[](README.md)
[](../../LICENSE)
[]()
[]()
让整个服务器网络的玩家可以一起聊天。**只需在 Velocity 代理端安装**，子服务器无需安装任何插件。
## ✨ 功能特性
- **跨服广播** — `/br <消息>` 把聊天消息发送到所有子服的所有玩家
- **颜色代码** — 完整支持 `&` 颜色代码（`&c`、`&6`、`&l`、`&r`……）
- **进服/切服/离服消息** — 玩家进服、切换服务器、断开连接时自动广播
- **服务器别名** — 用 "登录服" 之类的友好名称代替原始服务器 ID（如 `lobby`）
- **群组称号** — 创建群组并给成员设置称号前缀，显示在聊天中的玩家名前
- **权限细分** — `velocitychat.admin.*` 子权限节点，可与 LuckPerms 搭配（可选依赖）
- **广播冷却** — 可选的防刷屏冷却，管理员可绕过
- **消息可见性** — 进服/切服/离服提示可设为 全体可见 / 仅管理员 / 关闭
- **双语言** — 内置简体中文 `zh_CN` 和英文 `en_US` 语言文件，运行时可切换
## ✅ 环境要求
| 要求 | 版本 |
|---|---|
| Java | 17+ |
| 代理端 | Velocity 3.x - 4.x（所有现代版本） |
| 可选 | 权限插件（如 [LuckPerms](https://luckperms.net)）用于细分管理权限 |
## 安装方法
1. 下载插件 JAR（自行编译或下载发行版）
2. 放入 Velocity 代理端的 `plugins/` 文件夹
3. 重启服务器
4. 首次运行会自动生成 `config.yml`——请检查配置，修改后重启生效
> **子服无需任何插件** — 全部在代理端运行。
## 命令
### 玩家命令
| 命令 | 说明 | 权限 |
|---|---|---|
| `/br <消息>`（别名 `/broadcast`，可自定义） | 向所有玩家发送跨服聊天消息 | 所有玩家 |
### 管理命令（`/velocitychat`，别名 `/vchat`）
| 命令 | 说明 | 权限 |
|---|---|---|
| `/vchat create group <名称> [称号]` | 创建群组并可设置称号 | `velocitychat.admin.create` |
| `/vchat group <名称> join <玩家>` | 将玩家加入群组 | `velocitychat.admin.group.join` |
| `/vchat group <名称> remove <玩家>` | 将玩家移出群组 | `velocitychat.admin.group.remove` |
| `/vchat group <名称> settitle <称号>` | 修改群组称号 | `velocitychat.admin.group.settitle` |
| `/vchat group <名称> delete` | 删除群组 | `velocitychat.admin.group.delete` |
| `/vchat group list` | 查看所有群组及成员 | `velocitychat.admin.group.list` |
| `/vchat reload` | 热重载配置、语言文件和群组数据 | `velocitychat.admin.reload` |
称号支持 `&` 颜色代码，例如 `/vchat create group admin &c&l[管理员]`。
## 权限
| 权限 | 说明 |
|---|---|
| `velocitychat.admin` | 顶级管理权限——包含所有子权限，并绕过广播冷却 |
| `velocitychat.admin.create` | 创建群组 |
| `velocitychat.admin.group.*` | 所有群组管理权限的通配符 |
| `velocitychat.admin.group.join` | 添加成员 |
| `velocitychat.admin.group.remove` | 移除成员 |
| `velocitychat.admin.group.settitle` | 修改称号 |
| `velocitychat.admin.group.delete` | 删除群组 |
| `velocitychat.admin.group.list` | 查看群组及成员 |
| `velocitychat.admin.reload` | 重载配置 |
> **提示：** LuckPerms 示例 — `/lpv user <玩家> permission set velocitychat.admin true`
## 配置说明（`config.yml`）
生成的配置文件中所有选项都带注释，主要设置如下：
| 设置项 | 默认值 | 说明 |
|---|---|---|
| `language` | `zh_CN` | 语言文件：`zh_CN` 或 `en_US` |
| `broadcast-aliases` | `br`、`broadcast` | 跨服广播命令的别名 |
| `broadcast-cooldown` | `0` | 两次 `/br` 的最小间隔（`0` = 无冷却） |
| `broadcast-cooldown-bypass` | `false` | 启用后，拥有 `velocitychat.admin` 的玩家无视冷却 |
| `server-aliases` | 6 个预设 | 需要显示本地化名称的服务器列表 |
| `notify-mode` | `all` | 进服/切服/离服消息可见性：`all`、`admin`（仅管理员）、`none`（关闭） |
| `groups` | — | 首次启动时生成的预设群组 |
| `messages` | — | 覆盖语言文件中的指定消息（优先级更高） |
群组数据保存在 `groups.yml` 文件中。
## 从源码构建
需要 JDK 17+ 和 Maven 3.8+。
```bash
git clone https://github.com/LiquidTeamYHC/Velocity_Plugin.git
cd Velocity_Plugin/VelocityChat
mvn package
```
构建产物位于 `target/VelocityChat-1.7.0.jar`。
## 更新日志
完整版本历史请见 [更新日志-CHANGELOG.md](更新日志-CHANGELOG.md)。
## 作者
- **YuHongChen（LiquidTeam）** — 主要开发者
- QQ：`1464670605`
## 开源协议
本项目基于 [MIT License](../../LICENSE) 开源。
[/MD]
