Getting started
Requirements
| Requirement | Version |
|---|---|
| Java | 25+ |
| Paper (or fork) | 1.21.4+ |
| Vault (optional) | Any |
| WorldGuard (optional) | 7.x |
Installation
- Download the latest
ezclean-*.jarfrom SpigotMC or from the GitHub releases page. - Place the JAR in your server’s
plugins/folder. - Restart the server (or use a plugin loader that supports hot-loading).
- EzClean will create its data folder at
plugins/EzClean/containing:config.yml— global settingsdeath-chests.yml— death chest feature toggle and settingsmessages.yml— all player-facing messages (MiniMessage format)cleaners/default.yml— the default cleanup profile
First run
After installation, a single default cleaner is active.
It runs every 60 minutes and removes hostile mobs, dropped items, projectiles,
experience orbs, area-effect clouds, falling blocks, and primed TNT.
All heavy features (pile-detection, warnings, cancellation, async removal, death chests)
are off by default. Enable them safely one at a time via /ezclean toggle or by editing
the relevant YAML files and running /ezclean reload.
Verify it is working
/ezclean time # Shows minutes until the next cleanup run
/ezclean run # Triggers a manual cleanup immediately
/ezclean stats # Shows total runs and removed entity counts