ClearOnWorldGuard/README.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

2023-12-17 03:59:36 +01:00
# Clear on WorldGuard
This plugin will clear a player's items when they enter or leave, or teleport to or from one of the configured regions.
This is mainly useful if players are able to temporarily go in creative mode in specific WorldGuard regions. A lot of
additional things are blocked within clear regions in order to prevent creative mode abuse, such as: projectiles, XP
bottle usage, spawn egg usage, changing the mob in a spawner, dropping items, picking up items, breaking, placing or
interacting with blocks across clear region borders, block drops, pistons pushing or pulling across clear region
borders, TNT priming and keeping any inventory items if dying within a clear area. This list might not be exhaustive.
2023-12-17 03:59:36 +01:00
## Dependencies
- WorldGuard
## Configuration
Add the identifier (name or UUID) of the world you want to specify a region for as a sub-key of clearRegions. Make sure
your world identifier is a string list "worldName: []", and add any regions you want to enable inventory clearing for to
the list of the world the region belongs to.
Example config:
```yaml
clearRegions:
world:
- "creative_building"
- "clear"
```
or
```yaml
clearRegions:
world: [ "creative_building", "clear" ]
```