Content generated with AI — it may contain mistakes.

ExyliaProtections/Getting startedUpdated in v1.1.0

Introduction

What ExyliaProtections is, what it covers, what it needs to run and how this documentation is organised.

Page 1 of 254 min read

In about ten minutes you have players protecting land with a core they buy in /protections, adding friends, and flipping flags like PvP and mob spawning. PacketEvents is optional and WorldGuard is not needed. This page says what is included and what to install first.

ExyliaProtections lets players protect land. A protection is a box of blocks with an owner, members, roles and flags, made by placing a core block or by selecting two corners. Everything an owner does with it — members, roles, flags, bans, the bank, plots, a public warp — is done from /protections, and most of it also from a command standing inside the land.

It is a premium plugin, sold on BuiltByBit and installed through a licence loader. Protections used to be a module of ExyliaSurvivalCore; they are now this plugin, with its own tables, and the old module's data is not imported. See Migration.

What you have in 10 minutes#

  1. Install the loader jar and start the server (Installation).
  2. Hand yourself a core with /protectionsadmin give <player> small, place it, and the land is protected.
  3. Right-click the core, add a friend and change a flag (Your first protection).

Nothing else needs setting up for that. Selecting two corners needs PacketEvents and selection.enabled; the shop needs an economy plugin.

What is included#

Only the core of the plugin is on after a fresh install: protecting land with cores, members, roles, flags, bans, lock, greetings, logs and border previews. Protecting by selection is off too (selection.enabled). Raids, the bank, upkeep, the market, rent, plots, upgrades, warps, perks, time and weather and merging each have a switch in submodules, all off. See Configuration.

Requirements#

RequirementDetail
ServerPaper 1.21.1 or newer, or a fork of it. Folia 1.21.4 or newer.
Java21
Required dependenciesExyliaLib 1.572.0 or newer — installed for you if it is missing
Optional dependenciespacketevents (selecting two corners, raid replays and corner pillars on borders), ExyliaSurvivalCore, ExyliaEconomy or Vault, PlaceholderAPI, WorldGuard and WorldEdit, BlueMap, dynmap, Worlds or Multiverse-Core

What each optional plugin adds is listed on Installation.

About ExyliaLib

Configuration, the menus and their prompts, the database, the selector, economy, clans, teleports, placeholders and the cross-server channels all come from ExyliaLib. ExyliaProtections is written on top of it and does not run without it, which is why the loader installs it on a server that lacks it.

How a network sees protections#

Every protection is one row in the database, and every server sharing that database keeps all of them in memory. A player's list and their limits count every server. Only the server a protection was made on enforces it, draws it and mirrors it to WorldGuard; the others list it and can teleport a member to it. With Redis configured, a change made on one server reaches the others at once.

How to read this documentation#

Getting started

Installation, then a first protection with a member and a flag in a few minutes.

Protecting land

Cores, the selector and limits, the two backends, people and access, and the menus.

Systems

Raids, the economy, the land tools, warps, administration and migrating from ExyliaSurvivalCore or ProtectionStones.

Reference

Commands, permissions, placeholders, every configuration key, the developer API and the questions that come up most.

Conventions#

  • Values marked as default are what the plugin writes the first time it starts. If the file already exists, your value is kept.
  • Identifiers between < and > are variables. /protections warp <name> means /protections warp spawn, not /protections warp <spawn>.
  • "The protection here" is the protection the player is standing in. Commands that act on land act on that one.
  • Colours use ExyliaLib palette tokens ({primary}, {highlight}, {muted}), and & codes work too.

Something missing on this page? Tell us on Discord