# YAWL (Yet Another Whitelist Plugin)
**YAWL** 是一个极其简单、轻量级且高效的白名单插件，专为 **Velocity** 代理设计。 如果您需要一种无需繁琐、易于管理的白名单解决方案，并且它能正常工作，那么这个插件就是您的最佳选择。
## 🚀 概述
YAWL 的核心理念是 **简洁**。 在复杂插件的世界里，YAWL 凭借做好一件事并做到最好而脱颖而出。 它通过一个纯文本文件（`whitelist.txt`）管理服务器白名单，便于查看、编辑和管理，无需数据库或复杂的命令。 它被设计成尽可能高效且不具侵入性，确保对服务器性能的零影响。
## ✨ 为什么选择 YAWL？
* **⚡ 轻量级：** 该插件占用的空间最小。 它被编写成极其高效，不会为您的代理添加任何膨胀或延迟。
* **✏️ 简单的基于文本的管理：** 所有白名单玩家都存储在简单的 `whitelist.txt` 文件中。 您可以直接编辑此文件并在游戏中重新加载插件。
* **⚙️ 简单易懂的配置：** 一个干净的 `config.toml` 文件允许您轻松地切换白名单，更改消息语言并设置区分大小写。
* **🌍 多语言支持：** YAWL 带有多个预包装的语言（`en`, `ar`, `de`, `es`, `fr`, `ja`, `ru`, `uk`, `zh-cn`, `pt-br`, `tr`）。 甚至可以 **自动在玩家客户端的语言中显示消息**！
* **🔄 实时重新加载：** 无需重新启动整个代理。 一个简单的命令可以立即重新加载配置和白名单。
* **🔒 权限就绪：** 细粒度的权限节点让您完全控制谁可以管理白名单。
## 📦 安装
1. 从 [Releases](https://github.com/renwixx/YetAnotherWhitelistPlugin/releases) 页面或 Modrinth（目前不可用）下载插件的最新版本。
2. 将下载的 `.jar` 文件放入您的 Velocity 代理的 `plugins` 文件夹中。
3. 启动或重启您的代理。
4. 默认配置（`config.toml`）、语言文件和空的 `whitelist.txt` 文件将在 `plugins/yawl` 中生成。 编辑它们以满足您的需求！
## ⚙️ 配置
配置在 `plugins/yawl/config.toml` 文件中处理。
```toml
[settings]
# 启用或禁用白名单。 如果为 false，插件不会踢出任何人。
enabled = true
# 设置插件消息的语言。
# 对应于 'locales' 文件夹中的文件名（例如：“en”、“ru”）。
locale = "en"
# 如果为 true 并且客户端设置了语言，该语言存在于插件的语言文件夹中，则它将显示。
# 如果为 false，将显示上级设置中定义的默认语言。
use-client-locale = false
# 如果为 true，白名单中的玩家名称将区分大小写（例如，“Player”与“player”不同）。
# 如果为 false，则忽略大小写（“Player”和“player”相同）。
# 建议将其保持为 'false' 以方便用户使用。
case-sensitive = false
# 在白名单移除或过期后立即踢出活动玩家。
# 如果为 false，玩家将保持连接，直到他们重新连接或重新加载为止。
kick-active-on-revoke = true
# 占位符重新加载间隔（分钟）
placeholder-reload-interval = 2
```
## 🆔 占位符
从版本 1.2 开始，您可以使用占位符 `%yawl_duration%`，其中包含玩家剩余的时间。 要使用占位符，您需要在后端服务器(s)上安装 [YetAnotherWhitelistCompanion](https://github.com/renwixx/YetAnotherWhitelistCompanion) 和 [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)。
## 💬 命令
所有命令都以 `/yawl` 开头。
| 命令 | 描述 |
| --------------------------------- | --------------------------------------------------- |
| `/yawl` | 显示插件帮助消息。 |
| `/yawl add ` | 将玩家添加到白名单。 |
| `/yawl add []` | 将玩家添加到白名单，为特定时间。 |
| `/yawl extend [] [add|replace]` | 为特定玩家添加时间。 如果白名单计时器已过期，它将建议根据实际时间替换时间或添加到旧时间限制。 |
| `/yawl remove ` | 从白名单中移除玩家。 |
| `/yawl list` | 显示所有白名单玩家的列表。 |
| `/yawl reload` | 重新加载配置和 `whitelist.txt`。 |
## 🔑 权限
向您的工作人员组授予这些权限以控制谁可以管理白名单。
| 权限 | 描述 |
| ---------------------- | ------------------------------------------------------------- |
| `yawl.bypass` | 允许玩家即使不在白名单上也可以加入服务器。 |
| `yawl.command.add` | 允许使用 `/yawl add` 命令。 |
| `yawl.command.extend` | 允许使用 `/yawl extend` 命令。 |
| `yawl.command.remove` | 允许使用 `/yawl remove` 命令。 |
| `yawl.command.list` | 允许使用 `/yawl list` 命令。 |
| `yawl.command.reload` | 允许使用 `/yawl reload` 命令。 |