# EduGuard
EduGuard 是一个为 Minecraft Java 版设计的 PaperMC 插件，用于管理课程表并根据这些课程表自动执行各种游戏内操作。它提供诸如自动将玩家踢出服务器、在课程结束时启用/禁用白名单以及根据预定义的课程结束时间重置游戏内时间等功能。
## 功能
- **自动踢出**: 在课程结束时自动将玩家踢出服务器。
- **白名单管理**: 在课程结束时启用和禁用白名单，以防止重新加入。
- **时间重置**: 基于课程表重置游戏内时间，使每个会话具有相似的体验。
- **脏话过滤器**: 内置的脏话过滤功能，用于聊天消息和用户名。
- **可配置设置**: 所有功能都可以通过 YAML 配置文件进行高度配置。
## 安装
1. 从 [Modrinth](https://modrinth.com/plugin/edu-guard/versions)、[Hangar](https://hangar.papermc.io/megabyte6/EduGuard/versions) 或 [GitHub Releases](https://github.com/megabyte6/EduGuard/releases/latest) 下载 EduGuard 的最新版本。
2. 将 `.jar` 文件放置在 Minecraft 服务器的 `plugins/` 目录中。
3. 启动您的服务器以生成默认的配置文件。
4. 通过编辑位于 `plugins/EduGuard/` 目录中的 `config.yml` 文件来配置插件。
## 配置
主配置文件是 `config.yml`。在这里，您可以启用或禁用功能，并设置各种参数，例如课程结束时间、自动踢出设置、白名单设置和重置时间设置。
### 示例配置
配置使用 [YAML](https://yaml.org/)。
```yaml
auto-kick:
enabled: true
message: Server is now closed. Time to exit the Dojo!
before-end-of-class: 60 # seconds
show-warning: true
enable-whitelist-on-kick: true
disable-whitelist-after: 360 # seconds (six minutes)
reset-day:
enabled: true
before-end-of-class: 600 # seconds (ten minutes)
minecraft-world-name: "world"
minecraft-time: 6000 # ticks (Minecraft world time)
use-absolute-time: false
end-of-class-times:
monday:
- "15:00"
- "17:00"
tuesday:
- "15:00"
- "17:00"
# Add more days and times as needed
profanity-filter:
filter-chat: true
filter-usernames: true
prohibited-words:
- prohibited word 1
- prohibited word 2
# Add more words as needed
```
## 常见问题解答
### 关于 Minecraft 版本...?
您可以在 [Modrinth](https://modrinth.com/plugin/edu-guard/versions)、[Hangar](https://hangar.papermc.io/megabyte6/EduGuard/versions) 或 [GitHub Releases](https://github.com/megabyte6/EduGuard/releases/latest) 上找到适用于最新 Minecraft 版本的发布版。 较旧版本的支持可以根据要求提供。 如果您希望看到支持某个 Minecraft 版本，请 [提交问题](https://github.com/megabyte6/EduGuard/issues/new)。
### 1.0.0 到 3.1.0 版本发生了什么？
v1.0.0 到 v3.1.0 都使用了一个混乱且难以维护的旧配置系统。 在 v4.0.0 中，我重命名了项目，并且认为这是一个实施我一直想要进行的一些重大更改的好时机。 不幸的是，虽然这些更改使未来的编辑更容易，但从旧配置升级非常困难。 因此，为了减少代码库中的旧代码量，我已放弃对 v1.0.0 到 v3.1.0 的支持。 请不要使用这些版本。 这些版本中的所有功能都存在于 v4.0.0 中，并且应该以某种方式存在于所有未来的版本中，因此实际上没有理由去使用这些旧版本。
## 许可
本项目采用 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) 许可。