Installation & Setup

Requirements

Server Plugin (Paper)

Server Mod (Fabric)

Client Mod (Optional)

Paper Plugin Installation

1. Download the JAR

   Obtain ProtectedAreaPlugin-1.0.2.jar from your distribution source.

2. Place it in the plugins folder

   Copy the JAR to your server's plugins/ directory.

3. Start the server

   On first launch, the plugin automatically creates all required folders and configuration files inside plugins/ProtectedAreaPlugin/.

4. Verify the plugin loaded

   Check your server console for the line "[ProtectedAreaPlugin] Enabling...". The plugin is ready to use.

Generated File Structure (Paper)

plugins/
  ProtectedAreaPlugin/
    Config/
      Config.yml            ← mod-required flag and kick message
    AreaNotification/
      Rules.yml             ← basic rule violation messages
      AdvancedRules.yml     ← advanced rule violation messages
    Areas/                  ← one YAML file per cube area
    Areas/.flat/            ← one YAML file per flat area

Fabric Server Mod Installation

1. Install Fabric Server

   Download the Fabric server installer for Minecraft 1.21 and install it following the official Fabric documentation.

2. Add Fabric API

   Download the latest Fabric API for 1.21 and place it in your server's mods/ folder.

3. Add the server mod JAR

   Copy ProtectedAreaServer-1.0.2.jar into the same mods/ folder.

4. Start the server

   On first launch, the mod creates all required configuration inside config/ProtectedArea/.

Generated File Structure (Fabric Server)

config/
  ProtectedArea/
    Config/
      Config.yml            ← mod-required flag and kick message
    AreaNotification/
      Rules.yml             ← basic rule violation messages
      AdvancedRules.yml     ← advanced rule violation messages
    Areas/                  ← one YAML file per cube area
    Areas/.flat/            ← one YAML file per flat area
    assets/
      skybox/               ← skybox PNG textures (client-side, place here to distribute)

Client Mod Installation

1. Install Fabric Loader

   Download and run the Fabric Installer for Minecraft 1.21 from fabricmc.net/use/installer. Select your Minecraft version and click Install.

2. Add Fabric API

   Download the latest Fabric API for 1.21 and place it inside your .minecraft/mods/ folder. Fabric API is a required dependency.

3. Add the client mod JAR

   Copy ProtectedAreaClient-1.0.2.jar into the same .minecraft/mods/ folder.

4. Launch with the Fabric profile

   Open the Minecraft Launcher, select the Fabric profile, and launch the game. The mod activates automatically when connecting to a compatible server.

Skybox Assets

Custom skybox textures are PNG files that must be present on each client. Place them at:

.minecraft/config/ProtectedArea/assets/skybox/<name>.png

The <name> must match the name assigned to the area via /area cube skybox add <area_id> <name>. Distribute textures to your players alongside the mod.

Controls

Permissions

The plugin uses a single permission node that gates access to all administrative commands.