ProtectedArea — Overview

Overview

ProtectedArea is a two-component system: a Paper server plugin and an optional Fabric client-side mod. The plugin handles all protection logic, persistence, and command management on the server. The client mod extends the experience with features that require client-side rendering and physics.

The two components communicate over a custom plugin channel (protectedarea:main). When a player with the mod connects to a server running the plugin, the server sends area data, rule states, and debug information in real time. On servers without the plugin, the mod does nothing.

Architecture

Server Plugin (Paper)

The plugin manages all protected areas, enforces rules through Bukkit event listeners, stores data in YAML files, and exposes a single command tree (/area) to authorized administrators. It also handles plugin messaging to send area data to clients.

Client Mod (Fabric)

The mod receives area data from the server and provides three capabilities that cannot be implemented server-side alone:

Visual outlines — colored wireframe boxes rendered around each area
Physical barriers — client-side collision that enforces no_entry and no_exit rules
Debug HUD — a multi-page overlay with real-time area information

Features

Server Plugin

Protected Areas

Cuboid zones defined by two corner points. Fully persisted to YAML. Supports any world and dimension.

12 Basic Rules

Block breaking, placing, interaction, PvP, entity attacks, damage, drops, spawning, and movement barriers.

Advanced Rules

YES/NO rules targeting specific blocks or entities. Granular control beyond global restrictions.

Per-Player Exceptions

Grant individual players the ability to bypass any rule or the player limit in a specific area.

Player Limits

Cap the number of concurrent players in an area. Lock areas completely with a block flag.

CLIENT MOD

Entry / Exit Commands

Run server commands automatically when players enter or leave an area, with per-player usage tracking and delays.

CLIENT MOD

Area Priority

When areas overlap, the one with the highest priority value governs the rules at that position.

Teleportation

Teleport players to safe random locations inside an area, with support for batched and delayed groups.

Configurable Notifications

All rule violation messages use MiniMessage format and are fully editable without restarting.

Client Mod Features

Area Outlines

Colored wireframe boxes rendered in the world for every area the server sends. Toggled per player via /area view.

CLIENT MOD

Physical Barriers

Invisible collision walls enforce no_entry and no_exit rules client-side, allowing smooth movement blocking without teleporting.

CLIENT MOD

Debug HUD

A 5-page overlay in the top-right corner showing area ID, active rules, exceptions, player limit, and advanced rules. Navigate with arrow keys.

CLIENT MOD

Quick Start

The minimum steps to protect an area after installing the plugin:

Create an area

Stand in your world and run the create command with two corner coordinates.
```
/area create spawn -50 60 -50 50 90 50
```

Add rules

Apply one or more basic rules to restrict actions inside the area.

/area rules add spawn no_break
/area rules add spawn no_place
/area rules add spawn no_pvp

Grant exceptions (optional)

Allow specific players or staff to bypass all rules.
```
/area exception add spawn Marquinho all
```
Enable visualization (optional)

If the player has the client mod installed, show the area outline.
```
/area color spawn #4488ff Spawn Zone
/area view Marquinho true
```

Next Getting Started Requirements and installation Reference Areas & Rules All rules and how they work Reference Commands Full command reference