DUXPLIMA Documentation

Guard

Region protection with rules, roles and behaviours, built in, for Paper and Folia, one server or a network.

Guard protects areas of your worlds: who may build, open, fight, use items or walk in, what nature may do, and what happens to players inside (flight, game mode, messages, healing, blocked commands). It needs no other plugin and replaces WorldGuard, with an importer that brings WorldGuard regions over. The full manual is the Guard section; this page is the reference.

Module guard · enabled by default · modules/guard/config.conf

Commands

CommandWhat it doesPermission
/guard (/bolge, and /rg with commands.rg-alias)Protect regions: rules, roles, behaviours, history. Every subcommand is on Commandsuxmessentials.guard.use

Permissions

NodeDefaultGrants
uxmessentials.guard.backupsop/guard backups [restore <file>]: list the region backups, or put a backup's regions back.
uxmessentials.guard.bypassop/guard bypass: toggle ignoring every guard rule.
uxmessentials.guard.bypass.gamemodeoffKeep your own game mode in a region whose gamemode behaviour would change it.
uxmessentials.guard.defineop/guard define, redefine, wand, pos1, pos2, point, clear, expand: draw and define regions.
uxmessentials.guard.familyop/guard family <region> <name|clear>: group regions so their borders open to each other.
uxmessentials.guard.hereeveryone/guard here: the regions you stand in and your role there.
uxmessentials.guard.historyop/guard history <region>: the change history of a region.
uxmessentials.guard.importop/guard import worldguard: import WorldGuard regions, with dry-run and undo.
uxmessentials.guard.infoop/guard info <region>: a region's shape, rules, roles and behaviours.
uxmessentials.guard.inspectop/guard inspect: click a block to read what a player with no role may do there, and see why each of your own refusals happened.
uxmessentials.guard.listop/guard list [world]: list the regions of a world.
uxmessentials.guard.lockop/guard lock and unlock; edit and WorldEdit inside a locked region.
uxmessentials.guard.logop/guard log [player]: recent denied actions.
uxmessentials.guard.membereveryone/guard member <region> <player> <member|guest|clear>: owners and managers edit their own region's roster.
uxmessentials.guard.menuopSee the region list in /guard menu; without it a region owner or manager gets the roles window of the region they stand in.
uxmessentials.guard.nearop/guard near [radius]: list regions around you.
uxmessentials.guard.notifyopReceive staff alerts when players repeatedly hit guard denials.
uxmessentials.guard.parentop/guard parent <region> <parent|clear>: inherit rules from another region.
uxmessentials.guard.priorityop/guard priority <region> <value>: set a region's priority.
uxmessentials.guard.reloadop/guard reload: reload the guard config and recompile every world.
uxmessentials.guard.removeop/guard remove and restore: delete a region or bring a removed one back.
uxmessentials.guard.roleop/guard role <region> <player> <role|clear>: give any role on any region.
uxmessentials.guard.ruleop/guard rule <region> <action> <target> <allow|deny|clear>: edit a region's rules.
uxmessentials.guard.scopeop/guard scope <region> <server|set:name>: choose which servers a region applies on.
uxmessentials.guard.setop/guard set <region> <behaviour> <value>: set a region behaviour.
uxmessentials.guard.showop/guard show and hide: draw region borders for yourself.
uxmessentials.guard.statusop/guard status: engine counters and memory use.
uxmessentials.guard.tagop/guard tag <region> add|remove|bulk: tag regions and edit them by tag.
uxmessentials.guard.templateop/guard template <region> <template|clear>: apply a rule template.
uxmessentials.guard.testop/guard test <player> <action> [region]: check a verdict for another player.
uxmessentials.guard.undoop/guard undo <history id>: undo one change from a region's history.
uxmessentials.guard.useeveryone/guard and /guard help, actions: the base of every guard command.
uxmessentials.guard.whyeveryone/guard why <action>: explain the verdict for an action where you stand.
uxmessentials.module.guardopHot-reload / inspect the guard module (region protection).

Settings

KeyDefaultWhat it does
enabledtrueSwitches the module on or off.
network.shared-sets[]The shared region sets this server loads, besides its own regions. See Networks.
network.new-region-scope"server"Where new regions go: server (this server only) or set:<name>.
network.poll-seconds10How often this server checks the database for regions other servers changed, for when the network bus does not deliver.
deny-message.channel"actionbar"Where a refusal is shown: actionbar or chat.
deny-message.cooldown-ms1500At most one refusal message per player in this time.
bypass.reminder-seconds30How often a player with bypass on is reminded of it.
display.mode"lines"How /guard show draws borders: lines (glowing blocks) or particles.
display.seconds20How long borders stay.
display.range64How far around the player /guard show without a name looks for regions.
movement.check-ticks10How often each player's position, healing, feeding, interval actions and bypass reminder are checked, in ticks. It also catches moves that fire no event.
alerts.enabledtrueTells staff with uxmessentials.guard.notify when one player is refused many times.
alerts.threshold8How many refusals make an alert.
alerts.window-seconds20Within how many seconds.
alerts.cooldown-seconds60At most one alert per player in this time.
alerts.discordtrueAlso posts alerts through the Discord bridge when it is on.
log.enabledfalseKeeps every refused action in the database for /guard log.
log.keep-days14How long logged refusals are kept.
backups.keep10How many region backups are kept in guard/backups.
roles.extra[]Region roles beyond owner, manager, member and guest, for role:<name> rules.
commands.rg-aliasfalseAlso answer /rg. Off so WorldGuard keeps /rg while both are installed.
claims.guard-distance16uxmSimpleClaims refuses a claim inside a guard region or closer to one than this many blocks.
templatessix templatesNamed rule and behaviour sets: spawn, lobby, arena, market, parkour, build. See Templates.
worlds.default.high-frequencytruefalse skips liquid flow, fire spread, growth, decay, forming and melting for a world.
worlds.default.rules[]Rules every world without its own entry starts from.
worlds.default.behaviours[]Behaviours every world without its own entry starts from.

Placeholders

PlaceholderRenders
%uxmessentials_regions_available%Whether the guard module is on (yes/no). Every regions_ placeholder is also readable as guard_.
%uxmessentials_regions_inside%Whether the player is standing in a protected region (yes/no).
%uxmessentials_regions_here%The region the player is standing in, highest priority first when they overlap.
%uxmessentials_regions_here_priority%That region's priority, which is what decides an overlap.
%uxmessentials_regions_here_owners%Who owns the region the player is standing in, comma separated.
%uxmessentials_regions_here_members%Who may build in the region the player is standing in, comma separated.
%uxmessentials_regions_here_role%The player's role in the region they stand in (owner, manager, member, guest), or empty.
%uxmessentials_regions_allowed_<action>%Whether the player may do a guard action where they stand, such as regions_allowed_break.
%uxmessentials_regions_count%How many regions cover the player at once.
%uxmessentials_regions_world_count%How many regions are defined in the world the player is in.

Every placeholder above also answers under guard_ (%uxmessentials_guard_here%). regions_allowed_<action> takes any action from Actions, such as regions_allowed_use.door.

Notes

  • A new region does nothing until it has a rule or a template, so a region you are still drawing never locks anyone out.
  • Players can ask why. /guard why <action> is open to everyone and names the region and rule that decided.
  • Owners run their own roster. A region owner or manager hands out member and guest with /guard member or /guard menu, without any staff node.
  • Every change has a history and can be undone one by one, and a backup is written at start whenever the regions changed since the last one, ready for /guard backups restore.
  • Teleports are checked. /home, /warp, /tpa, /back and other plugins' teleports obey move.enter and move.teleport-in; /fly and /god obey the region's fly and god.
  • uxmSimpleClaims keeps its distance. Claims are refused inside a guard region or within claims.guard-distance of one.
  • Replaces the old Regions module, which was an editor for WorldGuard. /regions and its nodes are gone.

Related: Guard manual, Worlds, Player Warps