https://github.com/megabyte6/eduguard
A Minecraft Java PaperMC server plugin for managing and automating classroom servers.
https://github.com/megabyte6/eduguard
minecraft minecraft-plugin papermc
Last synced: about 1 month ago
JSON representation
A Minecraft Java PaperMC server plugin for managing and automating classroom servers.
- Host: GitHub
- URL: https://github.com/megabyte6/eduguard
- Owner: megabyte6
- License: gpl-3.0
- Created: 2023-11-11T08:00:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-29T08:34:29.000Z (over 1 year ago)
- Last Synced: 2025-03-13T20:13:03.900Z (over 1 year ago)
- Topics: minecraft, minecraft-plugin, papermc
- Language: Kotlin
- Homepage:
- Size: 378 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EduGuard
EduGuard is a PaperMC plugin for Minecraft Java Edition designed to manage class schedules and automate various in-game actions based on those schedules. It provides features such as automatic kicking of players, enabling/disabling the whitelist, and resetting the in-game day time based on predefined end-of-class times.
---
## Features
- **Automatic Kicking**: Automatically kicks players at the end of class.
- **Whitelist Management**: Enables and disables the whitelist around class end times to prevent rejoins.
- **Day Time Reset**: Resets the in-game day time based on class schedules so each session has a similar experience.
- **Profanity Filter**: Built in profanity filtering for chat messages and usernames.
- **Configurable Settings**: All features are highly configurable through a YAML configuration file.
---
## Installation
1. Download the latest release of EduGuard from either [Modrinth](https://modrinth.com/plugin/edu-guard/versions), [Hangar](https://hangar.papermc.io/megabyte6/EduGuard/versions), or [GitHub Releases](https://github.com/megabyte6/EduGuard/releases/latest).
2. Place the `.jar` file in your Minecraft server's `plugins/` directory.
3. Start your server to generate the default configuration files.
4. Configure the plugin by editing the `config.yml` file located in the `plugins/EduGuard/` directory.
---
## Configuration
The main configuration file is `config.yml`. Here you can enable or disable features and set various parameters such as class end times, auto-kick settings, whitelist settings, and reset day settings.
### Example Configuration
Configuration uses [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
```
---
## FAQ
### What about Minecraft version...?
You can find a release for the latest version of Minecraft on [Modrinth](https://modrinth.com/plugin/edu-guard/versions), [Hangar](https://hangar.papermc.io/megabyte6/EduGuard/versions), or under [GitHub Releases](https://github.com/megabyte6/EduGuard/releases/latest). Support for older version can be made available upon request. If there is a version of Minecraft you wish to see supported, [submit an issue](https://github.com/megabyte6/EduGuard/issues/new).
### What happened to versions 1.0.0 to 3.1.0?
v1.0.0 through to v3.1.0 all used an old config system that was messy and difficult to maintain. In v4.0.0, I renamed the project and felt it was a good time to implement some breaking changes I've been wanting to bring about for a while now. Unfortunately, while these changes make future edits much easier, upgrading from older configs is quite difficult. As such, to reduce the amount of legacy code in the codebase, I have dropped support for versions v1.0.0 to v3.1.0. Please do __not__ use those versions. All features from those versions are present in v4.0.0 and should exist, one way or another, in all future versions so there really is no reason to use bother with those legacy versions.
---
## License
This project is licensed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).