Content generated with AI — it may contain mistakes.

ExyliaProtections/GuidesUpdated in v1.1.0

Menus

Find every screen of /protections, restyle a button, and look up the file and action behind each one.

Page 6 of 2519 min read

Everything players do with their land happens in menus opened from /protections. Every button carries the protection's id in its action, so a screen holds no state of its own: a click is checked again against the protection as it is when the click arrives, and refused when the player lost the right to do it in the meantime.

Before you start#

Menu texts, colours and the way buttons are placed follow ExyliaLib, see Menus, Colours and Messages and languages. Edit only the files under menus/user/; the menus/admin/ ones are rewritten on every start.

Change a button#

Open the file

In the plugin folder open lang/<language>/menus/user/, for example main.yml for the /protections hub, in the language ExyliaLib is set to.

Edit it

Change a button's name, lore or slot, or its condition. Find the file for each screen in The other screens and the overview below.

Reload

Run /protectionsadmin reload.

Check that it works#

Run /protections and look at the button you changed. A file that does not parse is named in the console and left out, instead of opening as an empty screen.

The files#

Every screen is a file under lang/<language>/menus/, in the language folder ExyliaLib is set to (en, es, pt, fr, ru or tr).

FolderOwnerOn update
menus/user/Yours. Restyle, move and reword freely.Kept. Only missing files are written. A release that has to change a screen's layout raises its menu-version; that file is then replaced and your previous one kept next to it.
menus/admin/The plugin's.Rewritten from the jar on every start, so staff screens always match the release.

Each file's header comment lists the placeholders it receives. Buttons show only while their condition holds; the %…_enabled% placeholders are true or false from submodules. An action prefixed with left:, right:, shift_left: or shift_right: runs on that click only; without a prefix it runs on any click.

Many screens place their buttons through a groups entry instead of fixed slots: a group names a range of slots ("19-25", for example), and the buttons that name it with group: are drawn centred in that range, in file order, leaving no gaps for the ones whose condition hides them. The slots below are where the shipped files put each button with everything on; with fewer buttons visible they close up around the centre.

Menu files are read when the plugin enables and again on /protectionsadmin reload (or /protections admin reload) and /exylialib reload. A file that does not parse is named in the console and left out, instead of opening as an empty screen.

The hub#

/protections (or /ps, /claims) opens menus/user/main.yml, a 27-slot screen.

SlotButtonShown whileAction
4Your land: how many they own out of their limit, and how many they own or belong toalwaysnone
row 10-16My protectionsalwayslist
row 10-16Shop, with how many tiers are for salecores.enabled and some tier has a priceshop
row 10-16Select landselection.enabled and the player holds exyliaprotections.selectselect
row 19-25For sale, with how many are listedsubmodules.marketmarket
row 19-25For rentsubmodules.rentrent
row 19-25Public warpssubmodules.warpswarps

The first three are the group own and the last three the group offers, each drawn centred in its row.

The list#

menus/user/list.yml: every protection the player owns or belongs to, on any server, oldest first, 36 to a page. Each shows its owner, the player's role, size, location, server and member count.

ClickWhat it does
Left-clickOpens the protection's overview.
Right-clickTeleports home, with the teleport countdown.
Back (slot 49)The hub.

The overview#

menus/user/manage.yml is one protection's own screen: 45 slots, a summary at the top and one button per section, drawn centred in slots 19 to 25 (the group sections). It needs membership; admins open anybody's. A member also opens it by right-clicking the protection's core (not sneaking).

Overview buttons and section cards
SlotButtonShown whileAction
4The protection: owner, the player's role, tier, size, members, location, serveralwaysnone
row 19-25Landalwayssection <id> land
row 19-25Peoplealwayssection <id> people
row 19-25Accessalwayssection <id> access
row 19-25Economytwo or more of bank, upkeep, market, and rent with rent.whole-protectionsection <id> economy
row 19-25Growthboth upgrades and subregionssection <id> growth
row 19-25Defenseboth raids and logssection <id> defense
row 19-25Extrasboth warps and perks (effects or environment)section <id> extras
36Teleport homealwayshome <id>
40Backalwaysmanage_back <id>
44Deletealwaysdelete <id>

A section page never holds a single card. When only one feature of the Economy, Growth, Defense or Extras section is on, the overview shows that feature's own card in the section's place (economy_bank, economy_upkeep, economy_market, economy_rent, growth_upgrade, growth_subregions, defense_raid, defense_logs, extras_warp, extras_perks), running the same action the section's card would; with none on, nothing is shown. The placeholders %economy_view%, %growth_view%, %defense_view% and %extras_view% say which: section (two or more on), the key of the only card on (bank, upkeep, market, rent, upgrade, subregions, raid, logs, warp, perks), or none. The older %economy_enabled%, %growth_enabled%, %defense_enabled% and %extras_enabled% still work.

Back returns to the list, except for an admin looking at somebody else's protection, who goes back to the admin screen they came from. Every button is shown to every member; one their role does not allow answers "You cannot do that in this protection."

Sections, and the section that sticks#

Each section is a 36-slot screen, menus/user/manage_<section>.yml, whose cards are drawn centred in slots 10 to 16 (the group cards) and whose Back (slot 31) returns to the overview with section <id> hub. The slots below are those of the shipped files with every card on.

Opening a section remembers it for that player and that protection. Every later reopening of the protection's screen — a Back from members, roles, bans or logs, or the screen coming back after a change — lands on that section again, not on the overview. It is forgotten when the player goes back to the overview, opens another protection, or leaves the server. Opening a protection from the list always starts on the overview.

Every section and its buttons

Land — manage_land.yml

SlotButtonNeedsAction
4Summary: size, location, core statenone
11Set homeset-home, standing inside on its serversethome <id>
12Renamerenamerename <id>
14Hide coremanage-core, standing on its server and worldhide <id>
15Move protectionmanage-core, standing on its server and worldmove <id>
16Show border (while visualization is on)membershow <id>

People — manage_people.yml

SlotButtonNeedsAction
12Membersmanage-membersmembers <id>
13Rolesmanage-rolesroles <id>
14Bans (while bans is on)manage-bansbans <id>

Access — manage_access.yml

SlotButtonNeedsAction
12Flagsedit-flagsflags <id>
13Lock, open or locked (while lock is on)toggle-locklock <id>
14Greeting & farewell (while enter-leave is on): left greeting, right farewell, shift + right clears bothrenamegreeting <id> greeting|farewell|clear

Economy — manage_economy.yml

SlotButtonNeedsAction
10Bank (while bank is on): left deposit, right withdrawbank-deposit / bank-withdrawbank <id> deposit|withdraw
12Upkeep (while upkeep is on): pay what is duememberupkeep <id>
14Sell or give away (while market is on): left lists or unlists, right gives awayownersell <id>, transfer <id>
16Rent out (while rent and rent.whole-protection are on)manage-rentrent_offer <id> *

Growth — manage_growth.yml

SlotButtonNeedsAction
12Upgrade, level out of the highest (while upgrades is on)ownerupgrade <id>
13Plots, count out of the cap (while subregions is on)manage-subregionssubregions <id>

Defense — manage_defense.yml

SlotButtonNeedsAction
12Lives (while raids is on): buy a life backmemberraid_restore <id>
14Logs (while logs is on)view-logslogs <id> all _

Extras — manage_extras.yml

SlotButtonNeedsAction
12Public warp (while warps is on)manage-warpwarp <id>
14Perks & atmosphere (while effects or environment is on)owner, or edit-environmentperks <id>

Slot 4 of every section is a summary of what it holds and has no action.

The other screens#

Every list below is a 54-slot paged screen: up to 36 entries a page (fewer on the grid-shaped ones), previous and next page buttons, and Back in slot 49.

Every other screen
FileOpened byWhat it is
user/members.ymlmembersMembers and clans; see Members and clans. Clans use clan_template. Add player (45), Add clan (46).
user/roles.ymlrolesRoles, visitor last with visitor_template. Create role (45).
user/permissions.ymlflags, role_edit, overrides, subregion_flags, subregion_overridesOne list of switches. Its title names what it edits. Clicking a switch runs toggle; Back runs back.
user/shop.ymlshopEvery tier with a price. A click buys one core.
user/bans.ymlbansRunning bans. Right-click lifts one. Ban player (45).
user/logs.ymllogsThe audit log with its action and player filters (45, 46).
user/market.ymlmarketProtections for sale, each with its upkeep state and its bank, which goes to the seller (%protection_upkeep_state%, %protection_bank%, menu-version 3). Left buys, right visits.
user/rent.ymlrentThe player's own rentals first (rented_template: left renews, right teleports home), then every offer (left rents, right visits).
user/subregions.ymlsubregionsA protection's plots. Create plot (45).
user/subregion.ymlsubregionOne plot's members (left role, shift + left overrides, right removes) and its buttons: add member (45), plot flags (46), private (47), rent out (51, while rent is on), delete (53).
user/warps.ymlwarpsPublic warps. Left visits, right rates. Sort (45) cycles visits, rating, newest.
user/warp.ymlwarpOne protection's warp: publish, land here, rename, icon, description.
user/perks.ymlperksPerk switches for the owner, then time (38) and weather (42) while environment is on.
admin/hub.yml/protectionsadmin, admin_hubThe admin hub: protections, tiers, cleanup, settings, reload. See Administration.
admin/settings.yml, settings_*.ymlsettings_hub, settings_page, settingThe settings hub and its pages (general, features, systems, raids, upkeep, trade, teleport).
admin/raid_replays.yml, raid_replay_controls.yml/protectionsadmin replaysThe raid replays list and the controls shown while watching.
admin/admin.yml/protectionsadmin list, adminEvery protection on the network, with filters.
admin/admin_protection.ymladmin_protectionOne protection's admin buttons, centred in slots 19 to 25; Set level only while upgrades is on.
admin/tiers.yml, admin/tier.ymladmin_tiers, admin_tierThe tier editor.
admin/cleanup.ymladmin_cleanupThe inactive cleanup preview.

A switch in permissions.yml shows ON / OFF for flags and roles, ALLOW / DENY / ROLE for a member's overrides, and ALLOW / DENY / PROTECTION (follow the protection) for a plot's flags.

Actions#

Every button runs an action written exyliaprotections:<name> <arguments>, so a restyled menu can call any of them. Placeholders such as %protection_id% fill the arguments. Up to four arguments are read.

Before running, every action is refused while its feature is off ("That feature is turned off."), when the protection no longer exists ("That protection no longer exists."), or when the requirement below does not let the player through. <id> is a protection id. Most player actions also ask for their feature node, exyliaprotections.<feature>, which everybody holds by default ("Your rank does not include that feature."); the Permissions page lists which.

Every action

Land and the protection itself

ActionArgumentsNeedsWhat it does
openThe hub
listThe list
shopcores.enabledThe shop
selectexyliaprotections.select, selection.enabledHands out the selector
buy<tier>the tier's permission, cores.enabledBuys one core of a tier with a price
manage<id>memberThe overview, or the section that stuck
section<id> <land|people|access|economy|growth|defense|extras|hub>memberOpens a section and remembers it; hub or anything else opens the overview and forgets it
manage_back<id>The list, or the admin screen for an admin outside the protection
home<id>member or tenantTeleports home with the countdown
sethome<id>set-homeMoves the home to where the player stands, inside
rename<id>renameAsks for a name, up to 32 characters of plain text
hide<id>manage-coreHides or shows the core
move<id>manage-coreMoves the protection onto the block looked at, for settings.move-price
delete<id>ownerDeletes after a confirmation and hands the core back, blank. Pays its upkeep first when abandoned, after asking; refused while upkeep is due
raid_restore<id>member, raidsBuys a life back after a confirmation
show<id>member, visualizationDraws the border

People and access

ActionArgumentsNeedsWhat it does
members<id>manage-membersThe members screen
member_add<id>manage-membersAsks a player name, then a role
clan_add<id>manage-membersAsks a clan tag, then a role
member_role<id> <uuid|clan:<clan>>manage-membersAsks a new role
member_remove<id> <uuid|clan:<clan>>manage-membersRemoves a member or clan after a confirmation
overrides<id> <uuid>manage-membersA member's override switches
roles<id>manage-rolesThe roles screen
role_create<id>manage-rolesAsks a name and opens the new role
role_edit<id> <role>manage-rolesA role's switches
role_rename<id> <role>manage-rolesAsks a new name
role_delete<id> <role>manage-rolesDeletes after a confirmation
flags<id>edit-flagsThe flag switches
toggle<id> <target> <key>depends on the targetFlips one switch; see below
back<id> <target>Leaves a switch screen: a role to roles, a member to members, a plot target to the plot, anything else to the protection
lock<id>toggle-lock, lockLocks or unlocks; refused while visitor-entry is forced
bans<id>manage-bans, bansThe bans screen
ban_add<id>manage-bans, bansAsks who and for how long, with a summary
unban<id> <uuid>manage-bans, bansLifts a ban
greeting<id> <greeting|farewell|clear>rename, enter-leaveAsks the greeting or farewell, or clears both. Anything but farewell and clear edits the greeting
logs<id> <action|all> <player|_>view-logs, logsThe log, filtered; all and _ mean no filter
logs_action<id> <action|all> <player|_>view-logs, logsThe log with the next action filter
logs_player<id> <action|all>view-logs, logsAsks a player name to filter by

toggle targets, as PermissionTarget spells them:

TargetSwitchesNeeds
flagsThe protection's flagsedit-flags; refused for a forced flag
role:<name>A role's permissionsmanage-roles and holding the permission; not the role the player holds; never a management permission for visitor
player:<uuid>A member's overrides, cycling role, allow, denymanage-members and holding the permission; not themselves
sub:<plot>:flagsA plot's flags, cycling follow, on, off; visitor-entry excludedmanage-subregions; refused for a forced flag
sub:<plot>:player:<uuid>A plot member's overridesmanage-subregions and holding the permission; not themselves

Economy and estates

ActionArgumentsNeedsWhat it does
bank<id> <deposit|withdraw>bank-deposit or bank-withdraw, bankAsks an amount. Anything but withdraw deposits
upkeep<id>member, upkeepPays what is due
sell<id>owner, marketAsks a price and lists it, or unlists it when listed
transfer<id>owner, marketAsks a player name and gives the protection away
marketmarketThe market
market_buy<id>marketBuys a listed protection
market_visit<id>marketTeleports to a listed protection
upgrade<id>owner, upgradesUpgrades to the next level
subregions<id>manage-subregions, subregionsThe plots screen
subregion<id> <plot>sameOne plot
subregion_create<id>sameHands out the selector, then asks the name
subregion_delete<id> <plot>sameDeletes after a confirmation
subregion_private<id> <plot>sameToggles private and shared
subregion_flags<id> <plot>sameThe plot's flag switches
subregion_member_add<id> <plot>sameAsks a name, then a role
subregion_member_role<id> <plot> <uuid>sameAsks a new role
subregion_member_remove<id> <plot> <uuid>sameRemoves a plot member
subregion_overrides<id> <plot> <uuid>sameA plot member's override switches
rent_offer<id> <plot|*>manage-rent, rentAsks price and period with a summary, or cancels the running offer. * or blank is the whole protection
rentrentThe rent screen
rent_take<offer>rentRents an offer
rent_visit<offer>rentTeleports to an offer
rent_renew<id> <plot|*>rentRenews the player's own rental

Extras

ActionArgumentsNeedsWhat it does
warps[visits|rating|newest]warpsThe public warps, sorted; visits by default
warps_sort<current sort>warpsThe same, sorted by the next order
warp_visit<id>warpsVisits a warp
warp_rate<id> <sort>warpsAsks one to five stars, then returns to the list in that order
warp<id>manage-warp, warpsThe protection's warp screen
warp_toggle<id>samePublishes or unpublishes
warp_here<id>sameMoves the warp to where the player stands
warp_rename<id>sameAsks the warp's name
warp_icon<id>sameAsks the icon
warp_description<id>sameAsks the description
perks<id>owner or edit-environment; effects or environmentThe perks screen
perk_toggle<id> <perk>owner, effectsTurns an unlocked perk on or off
time<id>edit-environment, environmentNext time of day
weather<id>edit-environment, environmentNext weather

Admin

Every one of these needs exyliaprotections.admin. They are described on Administration.

ActionArgumentsWhat it does
admin_hubThe admin hub
settings_hubThe settings hub
settings_page<page>One settings page
setting<key>Edits one setting
admin_setting<key>Changes one setting: flips a switch, cycles a forced flag (allow, deny, not forced), adds or removes the admin's world, or asks a number or text
admin_reloadReloads the plugin, like /protectionsadmin reload
adminThe admin search
admin_filter<owner|text|world|server|state>Asks the owner or name filter, or cycles the world, server or state filter
admin_filter_clear<owner|text|world|server|state|all>Clears one filter; anything else clears them all
admin_protection<id>One protection's admin screen
admin_teleport<id>Teleports to it
admin_lives<id>Asks its lives (raids)
admin_raid_clear<id>Ends its raid (raids)
admin_abandoned<id>Takes it out of abandonment (upkeep)
admin_level<id>Asks its level
admin_transfer<id>Asks a new owner
admin_delete<id>Deletes after a confirmation
admin_tiersThe tier list
admin_tier<tier>One tier
admin_tier_createAsks a new tier id
admin_tier_edit<tier> <item|name|lore|radius|height|y-radius|price|currency|permission|limit|lives|upkeep>Edits one field
admin_tier_flag<tier> <flag>Toggles a starting flag
admin_tier_delete<tier>Deletes an unused tier after a confirmation
admin_cleanupAsks the days, then previews
admin_cleanup_view<days> <true|false>The preview, with or without never-seen players
admin_cleanup_run<days> <true|false>Runs the cleanup after a confirmation

Something missing on this page? Tell us on Discord