Описание
# CleanMaid
CleanMaid is a lightweight Minecraft server-side cleanup mod. Like a diligent maid on duty, it cleans dropped items and entities according to your configuration, reducing server load caused by entity buildup.
## Supported Versions
- Minecraft `1.21.1`
- NeoForge `21.1.222`
- Java `21`
## Main Features
- Automatically clears dropped items and experience orbs on a timer
- Warning and countdown messages before cleanup
- Two-level batched cleanup: dimension-level batching + entity-type batching within each dimension
- Item blacklist/whitelist and dimension blacklist/whitelist
- Protection for newly dropped items, named items, and player death drops
- `/cleanmaid` admin commands and shortcut command `/ccb`
- Configurable broadcasts via actionbar / chat
- Hidden Easter eggs and hidden advancements
## Installation
1. Install a Minecraft `1.21.1` server.
2. Install NeoForge `21.1.222`.
3. Place the main Mod jar from the release page into the server's `mods/` directory.
4. Start the server. The configuration files will be generated in `config/cleanmaid/`.
## Common Commands
All commands require permission level `3` by default.
```text
/cleanmaid help
/cleanmaid clean
/ccb
/cleanmaid status
/cleanmaid reload
/cleanmaid set interval 60
/cleanmaid set enabled true
/cleanmaid set easter_egg false
```
Blacklist and whitelist:
```text
/cleanmaid item blacklist add minecraft:dirt
/cleanmaid item blacklist remove minecraft:dirt
/cleanmaid item whitelist list
/cleanmaid dimension blacklist add minecraft:the_nether
/cleanmaid dimension whitelist add minecraft:overworld
/cleanmaid dimension whitelist list
```
Targeted cleanup:
```text
/cleanmaid clean dimension minecraft:the_nether
/cleanmaid clean item minecraft:cobblestone
/cleanmaid clean entity minecraft:experience_orb
/cleanmaid clean force
```
## Configuration Files
Configuration directory:
```text
config/cleanmaid/
```
Main files:
```text
cleanmaid-server.toml
blacklist.toml
whitelist.toml
```
`cleanmaid-server.toml` controls scheduling, target entities, protection rules, display location, sounds, permissions, and the Easter egg toggle.
`blacklist.toml` and `whitelist.toml` store both items and dimensions:
```json
{
"items": [],
"dimensions": []
}
```
## Blacklist and Whitelist Rules
- blacklist = must be cleaned
- whitelist = protected and will not be cleaned
- blacklist has higher priority than whitelist
Default items:
- blacklist: `minecraft:cobblestone`, `minecraft:dirt`
- whitelist: `minecraft:diamond`, `minecraft:netherite_ingot`
## Build
```powershell
.\\gradlew.bat build
```
Build artifacts are located in:
```text
build/libs/
```