Documentation
Protection and staffComplete

Regions

Protect areas of your worlds with rules, priorities, members and enter or leave messages.

The Regions module lets your staff protect areas such as the spawn, an arena or a shop district. Each region has its own rules (build, PvP, mob spawning, explosions and more), a priority for overlapping areas, members who can still build, and optional messages when players enter or leave. You also set the rules that apply everywhere outside regions.

Note

This module requires the complete edition. See editions.

Features

  • Box shaped regions defined by two corners, created in game with a selection wand or in the web editor with coordinates.
  • 19 rules per region. Each rule is Allowed, Denied or Inherited.
  • Priorities. When regions overlap, for each rule the region with the highest priority that sets it decides. If no region sets a rule, the global rule applies.
  • Members who keep building and interacting in the region even when those rules are denied.
  • Enter and leave messages shown in the action bar, the chat or as a title. {player} is replaced with the player's name, and color codes work.
  • Rules outside regions for the whole server.
  • Leak protection. Pistons, flowing water and lava, hoppers, dispensers, fire and explosions cannot reach into a protected region from outside.
  • Per server. Each server of your network has its own regions. In the web editor you can switch between servers to manage them all from one place.

Rules

Rule What it controls Members bypass a denial
Build Place and break blocks, buckets, item frames, paintings, armor stands, signs. Yes
Interact Doors, buttons, levers, entities. Yes
Open containers Chests, furnaces, barrels and other containers. Yes
PvP Player versus player combat. No
Mob damage Mobs hurt players. No
Hit animals Players can hurt animals. Yes
Damage When denied, players are invincible. No
Fall damage Falls hurt players. No
Hunger The hunger bar goes down. No
Mob spawning Hostile mobs spawn naturally. No
Explosions Explosions destroy blocks. No
Fire spread Fire spreads and burns blocks. No
Leaf decay Leaves vanish away from logs. No
Crop trampling Jumping on farmland destroys it. Yes
Drop items Players can drop items. No
Pick up items Players can pick up items. No
Ender pearls Teleport with a pearl into the area. No
Enter When denied, only members can enter. Yes
Leave When denied, the area can't be left. No

Setting it up

Open the Regions module in the web editor.

Regions tab

  • Click New region to create one with a name, a world, two corners (x, y, z) and a priority. Names use lowercase letters, digits and _, up to 32 characters.
  • Click a region to edit its Area, Priority, Enter message, Leave message, Members and Rules.
  • Delete removes the region.

It is often easier to create the area in game with /rg wand, then fine tune it in the editor.

Settings tab

Setting What it does Default
Selection item The item used as a selection wand. Left and right click a block to select an area. Wooden axe
Enter and leave messages Where region messages are shown: action bar, chat or title. Action bar
Rules outside regions One switch per rule, applied everywhere no region decides. All allowed

Commands

The /region command (aliases /rg and /zone) needs the inglis.region.admin permission.

Command What it does
/rg wand Gives you the selection item. Left click a block for point 1, right click for point 2.
/rg pos1 / /rg pos2 Sets point 1 or point 2 where you stand.
/rg expand Stretches the selection from the bottom to the top of the world.
/rg create <name> [priority] Creates a region from your selection.
/rg redefine <name> Moves an existing region to your current selection.
/rg delete <name> Deletes a region.
/rg flag <region> <rule> <allow|deny|reset> Sets a rule. reset makes it inherited again.
/rg priority <region> <number> Changes the priority.
/rg member <region> <add|remove> <player> Adds or removes a member.
/rg greeting <region> <text|reset> Sets or clears the enter message.
/rg farewell <region> <text|reset> Sets or clears the leave message.
/rg info [region] Shows the regions where you stand, or one region.
/rg list Lists the regions of this server.
/rg tp <region> Teleports you to the top of the region's center.

In commands, rule names are written in lowercase with dashes: build, interact, chest-access, pvp, mob-damage, animal-damage, damage, fall-damage, hunger, mob-spawning, explosions, fire-spread, leaf-decay, crop-trample, item-drop, item-pickup, enderpearl, entry, exit.

Permissions

Permission What it grants
inglis.region.admin Use /region and the selection wand. Operators have it by default.
inglis.region.bypass Ignore every region rule, including Enter and Leave. Operators have it by default.

Tips

Tip

Operators ignore region rules by default. To test a region, use an account that is not an operator.

  • To protect your spawn, create a region around it and deny Build, PvP, Damage, Hunger, Mob spawning and Explosions. Add your builders as members so they can keep working on it.
  • For an arena inside a protected spawn, create a smaller region with a higher priority that only allows PvP. Every other rule is inherited from the spawn region.
  • Clan land can never overlap a region. Player claims can't either while Keep out of staff regions is on in the claims module (the default). Inside a claim, any rule a region sets still wins over the claim.