Content generated with AI — it may contain mistakes.

ExyliaProtections/GuidesUpdated in v1.1.0

Administration

The /protectionsadmin hub, in-game settings, the admin search and the admin screen of one protection, the tier editor, the inactive cleanup and the staff log.

Page 11 of 2513 min read

What only staff do: find any protection on the network and put it right, change settings, tiers, forced flags and features without touching the file, and clear out land nobody plays in. Every menu and command on this page needs exyliaprotections.admin, which operators have by default.

Admin is not bypass

exyliaprotections.admin counts as the owner of every protection in menus and commands, and lets its holder enter every protection. It does not let them break, place or open anything inside one. That is exyliaprotections.bypass, which nobody has by default, operators included, and which only counts when it is set on the player. An admin breaking somebody's core is offered to pick it up, like its owner. See Permissions.

Fix a player's protection#

Find it

Run /protectionsadmin list <owner>, or /protectionsadmin and click Protections. Standing inside it, /protectionsadmin here opens it directly.

Open its admin screen

Left-click the protection in the list. Right-click teleports you to it instead.

Use a button

Click Open as owner to act as its owner, Transfer to hand it to a player by name, Set level, Lives or Force delete. Each is explained below.

Check that it works#

Every change is written to the protection's log as done by an admin (Logs, with submodules.logs on), and the important ones also appear in /exylialib logs. Open the protection's log and you should see your action.

The admin hub#

/protectionsadmin (also /psadmin, /padmin, or the old /protections admin) opens the hub: a header with how many owners there are, and one card per area.

CardOpensShows
ProtectionsThe admin search belowTotal protections
TiersThe tier editorHow many tiers
CleanupThe inactive cleanup
SettingsThe settings hub
ReloadRuns /protectionsadmin reload

Every subcommand is listed on Commands.

In-game settings#

The Settings card opens a hub with one card per theme, each showing its two values that matter. A theme opens a page of cards that say what the value does, its current value and its default. A click changes one and writes it into config.yml on the spot, checked like a value typed into the file: one it does not take is refused with the reason. Numbers are typed in; shift-right-click puts a value back to its default. The new value applies at once on this server; other servers reading the same file pick it up on their next reload or restart.

PageKeys
Generalsettings.default-limit, settings.min-distance, cores.enabled, selection.enabled, selection.price-per-block, selection.min-side, selection.max-area
FeaturesThe switches of submodules: bans, lock, enter-leave, logs, visualization, effects, environment, merge
SystemsThe switches for raids, upkeep, bank, market, subregions, rent, upgrades and warps
Raidsdefault-lives, core-health, lives-per-kill, raidable-minutes, cooldown-minutes, regen-minutes, restore-price
Upkeepperiod-hours, default-cost, cost-per-block, grace-periods, inactive-days, abandoned-days, charge-owner, cleanup.default-days, cleanup.skip-with-bank, cleanup.skip-with-tenants
Trademarket.max-price, market.tax-percent, rent.max-price, rent.max-periods, rent.min-period-minutes, rent.whole-protection, bank.max-balance
TeleportThe keys of teleport, such as warmup-seconds and cooldown-seconds

Forced flags are no longer a settings page: set them with /protectionsadmin flag. Turning a feature or a forced flag on or off also updates the mirrored WorldGuard regions with the WORLDGUARD backend, and /protectionsadmin feature does the same from the chat or the console. See Configuration for what a forced flag does.

/protectionsadmin reload reads config.yml, the messages and the menus again, re-applies the backend to every protection and restarts the upkeep, map and log timers.

The Protections card, or /protectionsadmin list [owner], lists every protection on the network, sorted by owner and then by name. Left-click one to open its admin screen; right-click teleports to it.

Five filters narrow the list. Left-click a filter to set it and right-click to clear it; right-click the Protection admin button in the middle to clear them all.

FilterHow it is set
OwnerTyped; any owner whose name contains it
NameTyped; a protection whose name contains it, or whose id starts with it
WorldEach click moves to the next world a protection is in, then back to any
ServerEach click moves to the next server, then back to any
StateAny → normal → raidable → abandoned → for sale → for rent → any

A protection's state is the most urgent thing about it, in that order: raidable, abandoned, for sale, for rent (it, or one of its plots, has a rent offer), normal. Each admin's filters are their own, and kept until they log out. /protectionsadmin list <owner> sets the owner filter before opening.

The row of a protection shows its owner, tier, size, world, server, core location, members and state. The Tier editor and Inactive cleanup buttons open the sections below.

The admin screen of a protection#

Opened from the search, or with /protectionsadmin here standing in the protection.

The top of the screen shows the owner, tier and level, state, size, members, bank, location, server, when its owner or a member last played, and how long ago it was made.

ButtonWhat it does
Open as ownerIts own protection screen. An admin passes every owner and role check there
TeleportTo its home, or on top of its core without one, on any server, with the teleport countdown
LogsIts audit log. With submodules.logs on
Set levelWith upgrades on. From 0 to the tier's highest level. See below
TransferType a player's name to hand it to them
LivesWith raids on. Left-click sets its lives; right-click clears its raid
UpkeepWith upkeep on. Forgives an abandonment
Force deleteDeletes it after a dangerous confirmation, whatever it is doing

Set level. A higher level grows the land the way an upgrade does, by the difference in radius-bonus, and is refused when the grown land would overlap another protection of that server and world. A lower level keeps the land as it is; only the level and what it unlocks change. Nothing is charged.

Set level checks less than an upgrade

Raising the level from the admin screen only checks for overlap. Unlike a player's upgrade it does not check settings.min-distance, foreign WorldGuard regions, disabled worlds or the world border, and it works while the protection is raidable, abandoned or rented.

Transfer. The player is found by name, online or not, and the protection is theirs, whatever their limits or the tier's permission say. Everything else follows the rules of a sale: members stay or go as market.keep-members says, rents end with each tenant paid back from the bank, and offers are withdrawn. See Economy. It is not refused while the protection is raidable, abandoned or rented.

Lives. Setting the lives asks for a number from 1 to the protection's maximum, ends any raid and cooldown, and starts the regrowth clock from now. Clearing the raid asks for a dangerous confirmation, then gives every life back, with no raid and no cooldown. See Raids.

Upkeep. Only for an abandoned protection: nothing is owed any more, the next period starts now, and the owner counts as seen, so the next check does not abandon it again at once. It is refused while the bank is busy. See Economy.

Force delete. Deletes it even while it is raided, abandoned, rented or for sale. Tenants are paid back from the bank first and the rest of the bank goes to the owner, as with any deleted protection. The core block is removed and not given back.

/protectionsadmin level, lives, transfer and delete do the same as these buttons for the protection you stand in.

Every change made here is written to the protection's log as done by an admin, and from the console as done by the console.

The staff log#

Since 1.0.2 what an admin does to somebody's protection is also recorded in ExyliaLib's staff log, read with /exylialib logs: who did it, the owner it was done to, and the protection's name, id and what changed.

Keys and defaults
ActionWhen
protection-livesLives set
protection-raid-clearRaid cleared
protection-levelLevel set
protection-transferHanded to another player
protection-deleteForce deleted
protection-cleanupRemoved by the inactive cleanup

Forgiving an abandonment and tier edits are not recorded there.

The tier editor#

Tiers in the hub, or /protectionsadmin tiers, lists every tier with its size, height, shop price, limit and how many protections on the network use it. New tier asks for an id, up to 32 of a-z, 0-9, - and _, and opens it with the fields of a new tier: an AMETHYST_BLOCK core named PROTECTION CORE, no lore, radius 10, FULL height, y-radius 10, not sold in the shop, no permission, no limit and no flags on.

What each tier button writes
ButtonWritesInput
Core blockmaterialPut in an item; it must be a block
NamenameText, up to 256 characters; colour tokens and &l allowed
LoreloreText, up to 2048 characters; lines split with |
Radiusradius0 to 512
HeightheightClick to switch between FULL and CUBOID
Cuboid heighty-radius0 to 512
Shop priceprice0 or more; 0 keeps it out of the shop
CurrencycurrencyClick to move to the next currency of the economy, then back to the default
PermissionpermissionText; - for none
Limitlimit0 to 1000; 0 for no limit of its own
Livesraids.tier-lives.<tier>1 to 100
Upkeepupkeep.tier-costs.<tier>0 or more
FlagsflagsOne switch per flag at the bottom, for the flags a new protection of this tier starts with

Each change rewrites config.yml on the spot and applies at once, on this server. Other servers reading the same file pick it up on their next reload or restart. A tier's lives and upkeep cost are kept in their own sections; a tier never given them uses raids.default-lives and upkeep.default-cost. What every key means is on Creating protections.

Delete tier is refused while any protection on the network uses the tier, and for the tier selection.tier names. After a dangerous confirmation the tier goes, with its lives and upkeep entries. Its core items stop working: placing one is refused.

A tier change does not reach existing protections

Protections keep the box they were given; a new radius or height only applies to cores placed afterwards. The same goes for the starting flags. Changing the core block is the one to be careful with: a core is only removed from the world while it is still the tier's block, so deleting or picking up a protection placed with the old block leaves that block standing.

Inactive cleanup#

Removes protections whose owner and members all stopped playing.

From the menu. Cleanup in the hub, or Inactive cleanup in the search, asks how many days, 1 to 3650, offering cleanup.default-days first, and opens the preview: every protection that would go, oldest first, with how long ago its players were last seen. Clicking one opens its admin screen.

ButtonWhat it does
Never seen playersSwitches whether protections with a player who was never seen are removed too
DaysAsks for other days
RemoveAfter a dangerous confirmation naming how many, removes them

From the command. Run by a player, /protectionsadmin cleanup <days> [--include-unknown] opens the same preview for those days. From the console it prints how many would go, how many were kept for having a never-seen player, a tenant or money in the bank, and the first ten with their world and server. Adding confirm runs it at once, with no further question. Days below 1 count as 1.

A protection is removed when:

  1. Its owner and every player member were last seen more than that many days ago. Clan members do not count: a clan is added whole.
  2. Nobody in it is unknown, never seen, unless --include-unknown, or the menu's Never seen players switch, is on.
  3. Nobody rents in it right now, with cleanup.skip-with-tenants.
  4. Its bank holds nothing, with cleanup.skip-with-bank.

"Last seen" is a player's last join or quit on any server of the network, and now while they are online on this server. The plan is made again when the removal starts, and each protection is judged once more just before it goes, so an owner who came back since the preview keeps their land. Removal runs batch-size protections a tick and tells whoever started it how many it removed. Each one is logged as removed by the inactivity cleanup, its bank goes to the owner, and its core block is removed.

Keys and defaults
KeyDefaultWhat it does
cleanup.default-days30Days the menu asks about first
cleanup.skip-with-tenantstrueKeep protections with a tenant renting in them right now
cleanup.skip-with-bankfalseKeep protections whose bank holds money. Off: the money is paid to the owner
cleanup.batch-size20Protections removed per tick while a cleanup runs
Nobody is inactive before the plugin has watched them

When protections load, every owner and member with no last-seen record is recorded as seen at that moment. On a server that just started using the plugin nothing is removed until that many days have passed, and "unknown" only covers players added since the last start who have not joined since.

A cleanup still running when the server stops is cancelled; what it had not removed yet stays.

Wiping data and resetting players#

There is no wipe or reset command of the plugin's own: ExyliaLib's /exylialib wipe and /exylialib resetplayer cover its tables. Each table is classified by what it holds:

Keys and defaults
KindTables
WORLDprotections, protections_accounts, protections_listings, protections_rent_offers, protections_warps, protections_warp_ratings, protections_warp_totals
HISTORYprotections_logs
CACHEprotections_seen, protections_warp_visits

/exylialib resetplayer <player> exyliaprotections deletes the rows that player owns: their protections, their sales and rent offers, their warp ratings and their last-seen record. A protection whose row is gone leaves memory at once, with its sale, rent offers and warp, its WorldGuard region and its core block. A reset that kept the protections changes nothing.

All keys#

The cleanup section of config.yml
plugins/ExyliaProtections/config.yml
yaml
cleanup:
  default-days: 30
  skip-with-tenants: true
  skip-with-bank: false
  batch-size: 20

Something missing on this page? Tell us on Discord