Content generated with AI — it may contain mistakes.

ExyliaProtections/ReferenceUpdated in v1.1.0

Configuration

config.yml section by section, the messages file and its languages, the menu files, and where the database is set.

Page 17 of 2525 min read
  - world_the_end       - break  - place  - containers  - doors  - redstone  - buckets    - SATURDAY 18:00-22:00    - SUNDAY 18:00-22:00    - break  - place  - containers  - doors  - redstone  - buckets  - animals  - ride  - decorations  - trade  - leash           - night-vision          - haste          - no-hunger          - speed          - fly           block-spread, snow-ice, item-drop, item-pickup, ender-pearl]

Everything is generated in plugins/ExyliaProtections/ on first start, with comments. Edit the files there, never the copies in the jar, and apply them with /protectionsadmin reload (it reads config.yml, the messages and the menus again) or a restart. Many settings can also be changed in game, which writes this file for you: see Administration.

The protections themselves are not in any file. They live in the database and are edited from the menus.

FileWhat it holds
config.ymlEvery setting below.
database.ymlExyliaLib's database connection.
lang/<language>/messages.ymlEvery line the plugin sends.
lang/<language>/menus/user/*.ymlThe players' screens.
lang/<language>/menus/admin/*.ymlThe staff screens.
Coming from ExyliaSurvivalCore

Up to 1.0.1 the first start copied ExyliaSurvivalCore's protections files here. Since 1.0.2 that import is gone: nothing is read from plugins/ExyliaSurvivalCore/. See Migration.

config.yml#

Each feature has a section of its own, then come the starting roles and the tiers. The config-version key is the plugin's own; leave it alone. The file is at version 8, and files at version 5, 6 or 7 are updated on start: version 6 moved settings.home-warmup-seconds to teleport.warmup-seconds, and version 7 added the new vanilla flags to every tier (see tiers), and version 8 rewrote tier lore that showed the full side (21x21) to show the radius (10x10).

settings#

yaml
settings:
  backend: INTERNAL
  worldguard-priority: 10
  default-limit: 3
  world-limits: {}
  min-distance: 8
  disabled-worlds:
  - world_the_end
  allowed-world-guard-regions: []
  move-price: 1000.0
  move-currency: ''
  deny-message-cooldown-millis: 1500
Keys and defaults
KeyDefaultWhat it does
backendINTERNALINTERNAL: the plugin enforces everything itself. WORLDGUARD: each protection is also a WorldGuard region with native flags. Change it with /protectionsadmin migrate, not here. See Backends.
worldguard-priority10Priority of the WorldGuard regions the plugin creates.
default-limit3Protections a player may own without any exyliaprotections.limit.<n>.
world-limits{}Protections a player may own per world, as world: number. A world left out has no limit of its own.
min-distance8Blocks that must separate protections of different owners.
disabled-worlds[world_the_end]Worlds where land cannot be protected.
allowed-world-guard-regions[]WorldGuard regions a protection may overlap. Every other region blocks it.
move-price1000.0What moving a core costs.
move-currency''Its currency; blank is the default one.
deny-message-cooldown-millis1500Milliseconds between two "this land is protected" messages to the same player.

exyliaprotections.limit.0 is a limit of zero, not a fallback to default-limit. See Permissions. The countdown before teleporting home is now teleport.warmup-seconds: see teleport.

submodules#

Turns whole features off. A feature that is off hides its buttons, refuses its commands and stops acting. Each one is also switched from the Features settings of the admin hub, or with /protectionsadmin feature <key> <on|off>.

Keys and defaults
KeyDefaultFeature
banstrueOwners ban players from their protections.
locktrueOwners lock a protection to members. Locking turns visitor-entry off.
enter-leavetrueTitles and sounds walking in and out, and owners' greetings and farewells.
logstrueAudit logs of blocks, containers and every change.
raidsfalseLives, core health, siege windows, offline shields. See Raids.
upkeepfalseProtections pay every period, and are abandoned and deleted when they stop.
bankfalseA shared bank per protection.
marketfalseSelling protections and giving them away.
subregionsfalsePlots inside protections with their own members and flags.
rentfalseRenting plots and protections to other players.
upgradesfalseLevels a protection is upgraded through.
warpsfalseProtections published as public warps with visits and ratings.
visualizationtrueDrawing borders, and markers on BlueMap and Dynmap.
effectsfalsePerks for members inside their protection.
environmentfalseA time of day and weather of its own inside a protection.
mergefalseA core placed touching another protection of the same owner grows that one instead of standing alone. There is no longer a merge screen or /protections merge.

cores#

yaml
cores:
  enabled: true
Keys and defaults
KeyDefaultWhat it does
enabledtrueWhether placing a core protects land. Off: cores cannot be placed, and the shop refuses to open and is hidden from the hub; protections already made with a core keep working. Turn it off for a selection-only server.

selection#

Off by default since 1.0.2: turn it on for a selection-only server, or alongside cores to offer both.

yaml
selection:
  enabled: false
  tier: medium
  height: FULL
  price-per-block: 5.0
  currency: ''
  min-side: 9
  max-area: 10000
  full-height-tool: GOLDEN_HOE
  normal-height-tool: GOLDEN_AXE
Keys and defaults
KeyDefaultWhat it does
enabledfalseWhether players may protect land by selecting two corners. Needs exyliaprotections.select too.
tiermediumThe tier a selected protection counts as, for its limit and starting flags. Since 1.0.2 the tier's permission is also required to select.
heightFULLFULL: the corners protect their whole column. NORMAL: only the blocks between both corners' heights.
price-per-block5.0Price per block of protected area.
currency''Its currency; blank is the default one.
min-side9The shortest side a selection may have.
max-area10000The largest area a selection may cover. exyliaprotections.select.area.<n> sets it per player.
full-height-toolGOLDEN_HOEThe selector for full-height selections and plots.
normal-height-toolGOLDEN_AXEThe selector otherwise.

The selector is an item only the player's client sees, through PacketEvents (optional; without it selection is unavailable), so it cannot be dropped, stored or sold. A tool name that is not an item falls back to the default. See Creating protections.

bans and enter-leave#

yaml
bans:
  reason-max-length: 64
enter-leave:
  enter-sound: BLOCK_AMETHYST_BLOCK_CHIME|0.6|1.4
  leave-sound: ''
  message-max-length: 64
  cooldown-millis: 1500
  show-to-members: true
Keys and defaults
KeyDefaultWhat it does
bans.reason-max-length64The longest reason a ban may carry.
enter-leave.enter-soundBLOCK_AMETHYST_BLOCK_CHIME|0.6|1.4Played walking in, as NAME|volume|pitch. Empty plays nothing.
enter-leave.leave-sound''Played walking out.
enter-leave.message-max-length64The longest greeting or farewell an owner may write.
enter-leave.cooldown-millis1500Milliseconds before crossing a border again shows anything, so walking along one stays quiet.
enter-leave.show-to-memberstrueWhether members see the titles too, or only visitors.

The titles and action bars themselves are enter-leave in messages.yml.

logs#

yaml
logs:
  retention-days: 14
  flush-seconds: 10
  skip-actions: []
  owner-blocks: false
  menu-rows: 500
Keys and defaults
KeyDefaultWhat it does
retention-days14Days an entry is kept. 0 keeps them forever.
flush-seconds10Seconds between two writes of the entries waiting to be saved.
skip-actions[]Actions not logged; everything else is, including actions added later. Actions: break, place, container, member, role, flag, ban, lock, core, settings, raid, bank, upkeep, market, subregion, rent, upgrade, warp, merge.
owner-blocksfalseWhether the owner's own blocks and containers are logged too.
menu-rows500The most recent entries the logs menu reads.

raids#

Only read while submodules.raids is on. See Raids for how they play.

yaml
raids:
  tier-lives:
    small: 3
    medium: 4
    large: 5
  default-lives: 3
  core-health: 150
  tool-damage:
    NETHERITE_PICKAXE: 4
    DIAMOND_PICKAXE: 3
    IRON_PICKAXE: 2
  default-damage: 1
  hit-cooldown-millis: 500
  core-heal-seconds: 30
  hit-sound: BLOCK_ANVIL_LAND|0.4|1.6
  lives-per-kill: 1
  kill-cooldown-minutes: 10
  allies-are-friends: true
  raidable-minutes: 30
  lives-after-raid: 1
  cooldown-minutes: 120
  raidable-permissions:
  - break
  - place
  - containers
  - doors
  - redstone
  - buckets
  explosions-while-raidable: false
  regen-minutes: 60
  restore-price: 5000.0
  restore-currency: ''
  allow-hidden-core: false
  explosion-core-radius: 4
  explosion-core-damage: 25
  attackers-ignore-lock: true
  siege-pvp: true
  selection-cores: true
  siege-windows:
    enabled: false
    timezone: ''
    windows:
    - SATURDAY 18:00-22:00
    - SUNDAY 18:00-22:00
  offline-shield:
    enabled: true
    grace-minutes: 10
    clan-members-count: false
  replays:
    enabled: false
    seconds: 60
    after-seconds: 3
    radius: 32
    keep-days: 30
Keys and defaults
KeyDefaultWhat it does
tier-livessmall 3, medium 4, large 5Lives a protection of each tier has.
default-lives3Lives of a tier left out of tier-lives.
core-health150Health of the core per life.
tool-damagethree pickaxesDamage one hit deals holding each item.
default-damage1Damage of anything else.
hit-cooldown-millis500Milliseconds a player waits between two hits on a core.
core-heal-seconds30Seconds without a hit before a damaged core heals to full.
hit-soundBLOCK_ANVIL_LAND|0.4|1.6Played on a hit.
lives-per-kill1Lives an enemy takes by killing a member inside. 0 turns it off.
kill-cooldown-minutes10Minutes before killing the same member there costs a life again.
allies-are-friendstrueWhether clan allies of the owner count as friends.
raidable-minutes30Minutes a protection stays raidable after losing its last life.
lives-after-raid1Lives it has once the raid ends.
cooldown-minutes120Minutes after a raid during which it cannot lose lives.
raidable-permissionsbreak, place, containers, doors, redstone, bucketsWhat enemies may do while it is raidable. Also what everybody may do in an abandoned protection.
explosions-while-raidablefalseWhether explosions break blocks in a raidable protection even with its explosions flag off.
regen-minutes60Minutes for one life to grow back. 0 turns it off.
restore-price5000.0What buying one life back from the menu costs. 0 turns it off.
restore-currency''Its currency; blank is the default one.
allow-hidden-corefalseWhether cores may be hidden while raids are on. A hidden core cannot be attacked, so with this off every hidden core is shown again when raids turn on.
explosion-core-radius4Blocks from a core within which TNT, TNT minecarts and end crystals damage it, through walls. Creepers and other mobs never do. 0 turns it off.
explosion-core-damage25Core health one such explosion takes. A defender's own explosions never count.
attackers-ignore-locktrueWhether enemies may walk into a locked protection, or one they are banned from, while it can lose lives.
siege-pvptrueWhether enemies and defenders may fight inside a protection that can lose lives, even with its pvp flag off.
selection-corestrueWhether protections made by selection get a core while raids are on, placed on the surface at their centre.
siege-windows.enabledfalseWhether lives can only be lost inside the windows. Off: any time.
siege-windows.timezone''The time zone the windows are read in, like Europe/Madrid. Blank: the server's.
siege-windows.windowsSaturday and Sunday 18:00-22:00DAY HH:MM-HH:MM, or DAILY for every day. A window ending before it starts runs past midnight.
offline-shield.enabledtrueWhether a protection cannot lose lives while every owner and member is offline.
offline-shield.grace-minutes10Minutes the shield waits after the last of them logs off on this server.
offline-shield.clan-members-countfalseWhether members of an added clan count as defenders too.
replays.enabledfalseWhether the minute before a protection becomes raidable is recorded as a replay staff can watch. Goes to ExyliaStaff's replays when its replay module is on, otherwise to this plugin.
replays.seconds60Seconds before the raid each replay reaches back (10 to 300).
replays.after-seconds3Seconds it carries on after the protection becomes raidable.
replays.radius32Blocks around the core it covers (8 to 96).
replays.keep-days30Days a replay kept by this plugin stays. 0 keeps them for good.

The hit action bar and the raidable boss bar are raids in messages.yml.

bank, upkeep and market#

yaml
bank:
  currency: ''
  max-balance: 0.0
upkeep:
  period-hours: 24
  tier-costs:
    small: 15.0
    medium: 40.0
    large: 100.0
  default-cost: 15.0
  cost-per-block: 0.0
  charge-owner: true
  grace-periods: 3
  inactive-days: 30
  abandoned-days: 3
  warn-hours: 12
  check-minutes: 10
  announce: false
  only-managers-keep-active: true
market:
  currency: ''
  tax-percent: 5.0
  max-price: 500000.0
  keep-members: false
Keys and defaults
KeyDefaultWhat it does
bank.currency''The currency banks hold and upkeep is paid in. Blank: the default one.
bank.max-balance0.0The most one bank may hold. 0 for no limit.
upkeep.period-hours24Hours between two payments.
upkeep.tier-costssmall 15, medium 40, large 100What one period costs per tier.
upkeep.default-cost15.0The cost of a tier left out.
upkeep.cost-per-block0.0Added to every period per block of protected area.
upkeep.charge-ownertrueWhether an owner online on the protection's server pays what its bank cannot.
upkeep.grace-periods3Unpaid periods that abandon a protection.
upkeep.inactive-days30Days without the owner or a member playing that abandon it. 0 turns it off.
upkeep.only-managers-keep-activetrueWhether only the owner and members allowed to manage-members keep it active. Off: any player member does, so one alt added as a member keeps it from going inactive.
upkeep.abandoned-days3Days an abandoned protection stays open to everyone before it is deleted.
upkeep.warn-hours12Hours before a payment the bank cannot cover when members are warned.
upkeep.check-minutes10Minutes between two checks of this server's protections.
upkeep.announcefalseWhether abandoning a protection is announced to everyone with raid announcements on.
market.currency''The currency protections are sold in.
market.tax-percent5.0Percent of the price taken as tax; the seller gets the rest.
market.max-price500000.0The highest price a protection may be listed for. 0 for no limit.
market.keep-membersfalseWhether members, clans and overrides stay when a protection changes owner.

See Economy.

subregions, rent and upgrades#

yaml
subregions:
  max-per-protection: 3
  min-side: 3
  full-height: true
rent:
  whole-protection: false
  currency: ''
  max-price: 50000.0
  min-period-minutes: 60
  max-periods: 4
  tenant-role: tenant
  tenant-permissions:
  - break
  - place
  - containers
  - doors
  - redstone
  - buckets
  - animals
  - ride
  - decorations
  - trade
  - leash
  pay-to-bank: true
  owner-can-evict: false
  relist: true
upgrades:
  pay-from-bank: false
  currency: ''
  base-max-members: 8
  base-max-subregions: 2
  tiers:
    small:
      levels:
        '1':
          cost: 3000.0
          radius-bonus: 5
          max-members: 12
          max-subregions: 3
          bonus-lives: 1
          permission: ''
        '2':
          cost: 6000.0
          radius-bonus: 10
          max-members: 16
          max-subregions: 4
          bonus-lives: 2
          permission: ''
    medium: ...
    large: ...
Keys and defaults
KeyDefaultWhat it does
subregions.max-per-protection3Plots one protection may hold while upgrades are off. 0 for no limit.
subregions.min-side3The shortest side a plot may have.
subregions.full-heighttrueWhether a plot spans the protection's whole height, or only the height selected.
rent.whole-protectionfalseWhether whole protections may be rented, not only their plots.
rent.currency''The currency rent is paid in.
rent.max-price50000.0The highest rent per period. 0 for no limit.
rent.min-period-minutes60The shortest period an offer may have.
rent.max-periods4The most periods a tenant may pay for at once, renewals included.
rent.tenant-roletenantThe role tenants hold. A protection without it gets it, with tenant-permissions.
rent.tenant-permissionsbuilding and usingWhat that role starts with.
rent.pay-to-banktrueWhether rent goes into the protection's bank when banks are on and the currency matches. Otherwise it goes to the owner.
rent.owner-can-evictfalseWhether a tenant can be evicted early; whoever evicts pays back the time left.
rent.relisttrueWhether a plot is offered again, on the same terms, when its rent ends.
upgrades.pay-from-bankfalseWhether the bank pays upgrades when banks are on and the currency matches. Otherwise the owner pays.
upgrades.currency''The currency upgrades cost.
upgrades.base-max-members8Members (players and clans) a protection holds before any upgrade. 0 for no limit.
upgrades.base-max-subregions2Plots it holds before any upgrade. 0 for no limit.
upgrades.tiers.<tier>.levels.<n>two levels per tierEach level from 1: its cost, the radius-bonus and bonus-lives totals at that level, its max-members and max-subregions (0 for no limit), and a permission needed to reach it (blank for none).

Shipped levels: small 3000 / 6000, medium 8000 / 16000, large 20000 / 40000, each adding 5 then 10 blocks of radius and 1 then 2 lives. See Land tools.

warps, visualization and effects#

yaml
warps:
  name-max-length: 24
  description-max-length: 64
  hide-unavailable: true
  default-icon: LODESTONE
visualization:
  seconds: 10
  particle: END_ROD
  plot-particle: WAX_OFF
  show-on-create: true
  bluemap: true
  dynmap: true
  map-refresh-minutes: 5
  map-colors:
    normal: '#8a51c4'
    for-sale: '#8fffc1'
    for-rent: '#59a4ff'
    raidable: '#a33b53'
    abandoned: '#6c757d'
effects:
  tenants: false
  fall-protection-seconds: 5
  no-flight-during-siege: true
  potions:
    night-vision: NIGHT_VISION 0
    haste: HASTE 0
    speed: SPEED 0
    jump-boost: JUMP_BOOST 0
  tiers:
    small:
      levels:
        '0':
          perks:
          - night-vision
        '1':
          perks:
          - haste
          - no-hunger
        '2':
          perks:
          - speed
          - fly
    medium: ...
    large: ...
Keys and defaults
KeyDefaultWhat it does
warps.name-max-length24The longest name a warp may have.
warps.description-max-length64The longest description.
warps.hide-unavailabletrueWhether warps a player cannot enter right now (locked, banned, raidable, abandoned) are hidden from them. Off: listed, and the visit is refused.
warps.default-iconLODESTONEThe icon a new warp starts with.
visualization.seconds10Seconds a border stays drawn.
visualization.particleEND_RODThe particle drawing a protection's border.
visualization.plot-particleWAX_OFFThe particle drawing a plot's border.
visualization.show-on-createtrueWhether the border is drawn to whoever protects new land.
visualization.bluemaptrueWhether protections are drawn on BlueMap, when it is installed.
visualization.dynmaptrueThe same for Dynmap.
visualization.map-refresh-minutes5Minutes between two redraws of every marker, which picks up sales, rents and raids.
visualization.map-colorsfive statesMarker colours by state, in hex: web maps cannot read colour tokens. A state left out or mistyped uses normal.
effects.tenantsfalseWhether tenants get the perks of what they rent, not only members.
effects.fall-protection-seconds5Seconds a player who stops flying takes no fall damage.
effects.no-flight-during-siegetrueWhether flight stops while a protection is under siege or raidable.
effects.potionsfour potionsPotion perks: a key of your choice to EFFECT amplifier, the amplifier counting from 0.
effects.tiers.<tier>.levels.<n>.perksper tierThe perks each level unlocks, from level 0. A level has every perk of the levels below it. Perks: fly, no-hunger, keep-inventory and the keys of potions.

See Warps and Land tools.

import and cleanup#

yaml
import:
  tier-map: {}
  default-tier: small
  owner-role: trusted
  member-role: member
  remove-source-regions: false
cleanup:
  default-days: 30
  skip-with-tenants: true
  skip-with-bank: false
  batch-size: 20
Keys and defaults
KeyDefaultWhat it does
import.tier-map{}ProtectionStones block (its ps-block-material, like EMERALD_ORE) to the tier it becomes. A block left out becomes the tier placed with the same block, else default-tier.
import.default-tiersmallThe tier for blocks nothing matches. Blank skips those regions.
import.owner-roletrustedThe role owners other than the first get.
import.member-rolememberThe role members get.
import.remove-source-regionsfalseWhether each imported region is removed from WorldGuard, so it stops enforcing its old owners and members. Run the import with --dry-run first.
cleanup.default-days30Days the cleanup button asks about first.
cleanup.skip-with-tenantstrueWhether protections with a tenant right now are kept.
cleanup.skip-with-bankfalseWhether protections whose bank holds money are kept. Off: the money is paid to the owner.
cleanup.batch-size20Protections removed per tick while a cleanup runs.

See Migration and Administration.

teleport#

Teleports home, to warps and to visited plots: the countdown, what calls it off and who skips it.

yaml
teleport:
  warmup-seconds: 3.0
  warp-warmup-seconds: -1.0
  cancel-on-move: true
  cancel-on-damage: true
  refuse-in-combat: true
  cooldown-seconds: 0.0
  bypass-permission: exyliaprotections.bypass.warmup
  tick-sound: UI_BUTTON_CLICK|0.6|1.3
Keys and defaults
KeyDefaultWhat it does
warmup-seconds3Seconds a player waits before being moved home or to a plot. 0 moves them at once. Was settings.home-warmup-seconds.
warp-warmup-seconds-1Seconds before visiting a warp. -1 uses warmup-seconds.
cancel-on-movetrueWhether stepping off the block they started on calls it off.
cancel-on-damagetrueWhether taking damage calls it off.
refuse-in-combattrueWhether a player tagged in combat cannot start one.
cooldown-seconds0Seconds a player waits between two teleports. A called-off one does not count. 0: none.
bypass-permissionexyliaprotections.bypass.warmupHolders move at once and skip the cooldown. Blank: nobody skips.
tick-soundUI_BUTTON_CLICK|0.6|1.3Played each whole second of the countdown, as NAME|volume|pitch. Blank for none.

While it counts down the player sees a boss bar with the destination and the time left, which clears however it ends; on arrival a title, a sound and particles play. Moving, taking damage, starting a second teleport or the cooldown each answer with their own line. Every text is the teleport section of messages.yml.

forced-flags#

Server rules every protection and plot follows, whatever its owner sets: a flag mapped to ALLOW or DENY.

yaml
forced-flags:
  pvp: DENY

Empty by default. A forced flag applies inside every protection and every plot, overrides the owner's and the plot's own setting, and cannot be changed from any protection's menu: its switch shows the forced state "set by the server", and clicking it, or locking with visitor-entry forced, says so. What owners had set is kept and comes back once the flag is no longer forced. A key that is not a flag, or a value other than ALLOW or DENY, is ignored. With the WORLDGUARD backend the mirrored regions carry the forced value. Change them in game from the Forced flags settings of the admin hub, or with /protectionsadmin flag <flag> <allow|deny|default>.

roles#

The roles a new protection starts with. Each protection then keeps its own copy, edited from its menu; changing this section does not touch existing protections.

yaml
roles:
  member:
    permissions: [break, place, containers, doors, redstone, buckets, animals, ride, decorations, trade, leash, bank-deposit]
  trusted:
    permissions: [break, place, containers, doors, redstone, buckets, animals, ride, decorations, trade, leash, manage-members, set-home, bank-deposit]
  visitor:
    permissions: []

visitor is everybody who is not a member. Permissions: break, place, containers, doors, redstone, buckets, animals, ride, decorations, trade, leash, manage-members, manage-roles, edit-flags, rename, set-home, manage-core, manage-bans, toggle-lock, view-logs, bank-deposit, bank-withdraw, manage-subregions, manage-rent, manage-warp, edit-environment. An unknown key is skipped. See People and access.

tiers#

The protection cores sold and given, keyed by tier id. Three ship: small (AMETHYST_BLOCK, radius 10, 2500), medium (PURPUR_BLOCK, radius 20, 10000) and large (CRYING_OBSIDIAN, radius 35, 40000).

yaml
tiers:
  small:
    material: AMETHYST_BLOCK
    name: '{primary}&lPROTECTION CORE &8[{info}SMALL&8]'
    lore: [...]
    radius: 10
    height: FULL
    y-radius: 10
    price: 2500.0
    currency: ''
    permission: ''
    limit: 0
    flags: [mob-spawning, crop-growth, leaf-decay, liquid-flow, visitor-entry, mob-damage, fall-damage, hunger,
      block-spread, snow-ice, item-drop, item-pickup, ender-pearl]
Keys and defaults
KeyWhat it does
materialThe core block.
name, loreThe core item's name and lore.
radiusBlocks protected around the core on each side.
heightFULL protects the whole column; CUBOID only y-radius blocks above and below the core.
y-radiusThe height used by CUBOID.
priceIts price in the shop. 0 keeps it out of the shop.
currencyIts currency; blank is the default one.
permissionNeeded to place it, buy it or receive one; blank for none.
limitHow many of this tier a player may own. 0 for no limit of its own. exyliaprotections.limit.<tier>.<n> overrides it per player.
flagsThe flags that start on. Flags: pvp, mob-spawning, explosions, fire-spread, liquid-flow, crop-growth, leaf-decay, visitor-entry, mob-damage, fall-damage, hunger, mob-griefing, block-spread, snow-ice, crop-trample, item-drop, item-pickup, ender-pearl.

The last ten flags arrived in 1.0.2. The eight that keep vanilla behaviour (mob-damage, fall-damage, hunger, block-spread, snow-ice, item-drop, item-pickup, ender-pearl) start on in every shipped tier, were added to every existing tier when the file was updated, and read as on in protections made before they existed, so nothing changes until an owner turns one off. mob-griefing and crop-trample start off. explosions no longer covers mobs that change blocks: that is mob-griefing now. See People and access for what each flag does.

Tiers are also edited in game from the tier editor of the admin hub, which writes this section along with the tier's lives and upkeep cost. See Administration.

messages.yml#

lang/<language>/messages.yml holds every line the plugin sends. The language is the one set in ExyliaLib's config.yml: unlike most Exylia plugins, ExyliaProtections' config.yml has no language key of its own. es, pt, fr, ru and tr ship translated (Russian since 1.0.2, Turkish since 1.1.0); English is written from the plugin's built-in defaults, and a line a translation leaves out arrives in English.

The top-level keys are chat lines, prompts and the words menus show, such as the raid and rent states. Then come the sections:

SectionWhat it holds
utilityWarps, borders, perks, time and weather.
utility.adminThe admin menus, the hub's settings and their labels, forced flags, the tier editor, cleanup and the ProtectionStones import.
utility.noticesRefusals and confirmations, the /protections help lines, and labels: the names and descriptions of every role permission and flag, of log actions and of perks.
raidsThe core-hit action bar and the raidable boss bar.
enter-leaveThe titles and action bars of walking in and out. %message% is the owner's greeting or farewell, or the default one.
visualizationThe marker label and layer name on BlueMap and Dynmap. Plain text: web maps read no colour tokens.
generalLines shared by every part of the plugin.
teleportThe countdown boss bar, the arrival effect, and the lines for a teleport already running, called off by moving or by damage, and the cooldown. Placeholders: %name%, %time%.

Colours use palette tokens such as {primary}, {error} or {highlight}, so recolouring the server never means editing this file. %prefix% is replaced by the prefix value at the top. A line may open with an effect tag that never reaches the screen: [sound:NAME|volume|pitch] plays a sound to whoever receives it. The values each line may use are written in the comment above it.

FolderWhat it holds
lang/<language>/menus/user/The players' screens: the hub, the list, the protection overview and its seven sections, members, roles, permissions, shop, bans, logs, market, plots, rent, warps, perks. Yours to restyle; an update only adds files that are missing.
lang/<language>/menus/admin/The staff screens: the hub, a settings group, admin search, one protection, tiers, one tier, cleanup. Rewritten from the jar on every start; edits there are lost.

A menu file that does not parse is named in the console and left out, rather than opening empty. See Menus for every file and the actions their buttons run.

Database#

database.yml is ExyliaLib's: H2 by default, or mysql, mariadb, postgresql and mongodb. See the library's database page for every key. Servers sharing one database share their protections.

The plugin's tables are protections, protections_accounts, protections_listings, protections_rent_offers, protections_logs, protections_seen, protections_warps, protections_warp_ratings, protections_warp_visits and protections_warp_totals, plus ExyliaLib's table of items waiting to be handed over.

Something missing on this page? Tell us on Discord