Region Commands

For a list of other (non-region protection related) commands, see the Commands page. Permissions for these commands is detailed on the Permissions page.

Some of these commands may run in the background and then later return results. The list of active background commands can be viewed with /wg running. There is a hard limit to the number of running and queued commands.

Either /region or /rg can be used for commands. Some sub-commands have multiple aliases (for example, /rg d can be used a shortcut to /rg define).

Tip

You can use most of these commands from console, but you may need to specify the -w flag (when available).

Creating and Removing Regions

Define

/rg define [-n] [-g] <id> <owner1> [<owner2>] [... <ownerN>]
/rg create (...)
/rg d (...)

Creates a new region with a given ID and an optional list of owners. Your current WorldEdit selection is used for the area of the region.

Region IDs are case-insensitive. Only one region can exist with a given name (per-world).

  • -g will create a new “global” region (not the same as the Global Region) that has no physical space, which is useful for creating template regions (see Priority and Inheritance)
  • -n will store the given owner names as names, rather than converting them to UUIDs

Example: Creating a new “shop” region with “sk89q” and “wizjany” as owners

/rg define shop sk89q wizjany

Remove

/rg remove [-w <world>] [-f] [-u] <id>
/rg rem (...)
/rg delete (...)
/rg del (...)

Removes a region.

If the specified region has child regions, then either -u or -f must be specified. Both options cannot be specified together.

  • -w <world> can be specified to run this command for a different world or from console
  • -u changes child regions of the specified region to have no parent
  • -f removes child regions of the specified region

Redefine

/rg redefine [-g]
/rg update (...)
/rg move (...)

Changes the physical area associated with an existing region and replaces it with your current WorldEdit selection.

Claim

/rg claim <id>

Claims a region, which is for self-serve player-created regions. See Claiming for more information.

Editing Memberships

Add Member

/rg addmember [-w <world>] [-n] <id> <members...>
/rg addmem (...)
/rg am (...)

Adds any number of members to a region. Using g:<member> will add a permission group instead of a player.

  • -w <world> can be specified to run this command for a different world or from console
  • -n tells WorldGuard to add players as names instead of UUIDs. Players added as names only will lose their membership if they change their Minecraft name.

Example: Adding the “builder” group and the player “sk89q” as members of a “spawn” region of the “lobby” world.

/rg addmember -w lobby spawn g:builder sk89q

Add Owner

/rg addowner [-w <world>] [-n] <id> <owners...>
/rg ao (...)

Adds any number of owners to a region. Using g:<owner> will add a permission group instead of a player.

  • -w <world> can be specified to run this command for a different world or from console
  • -n tells WorldGuard to add players as names instead of UUIDs. Players added as names only will lose their ownership if they change their Minecraft name.

Example: Adding the “admins” group and the player “eduardo” as members of a “spawn” region of the “lobby” world.

/rg addowner -w lobby spawn g:admins eduardo

Remove Member

/rg removemember [-w <world>] [-n] [-a] <id> <members...>
/rg remmember (...)
/rg remmem (...)
/rg rm (...)

Removes any number of members from a region. As in the add command, use g:<member> to specify a permission group.

  • -w <world> can be specified to run this command for a different world or from console
  • -n will remove a player who was added by name instead of UUID.
  • -a will remove all members from the region, ignoring the <members...> argument

Remove Owner

/rg removeowner [-w <world>] [-n] [-a] <id> <owners...>
/rg ro (...)

Removes any number of owners from a region. As in the add command, use g:<owner> to specify a permission group.

  • -w <world> can be specified to run this command for a different world or from console
  • -n will remove a player who was added by name instead of UUID.
  • -a will remove all owners from the region, ignoring the <owners...> argument

Getting Information

Select

/rg select <id>
/rg sel (...)
/rg s (...)

Replaces your current WorldEdit selection with the area of an existing region.

Information

/rg info [-u] [-s] [-w <world>] [<id>]
/rg i (...)

Displays information about a specified region, or if no region is specified, the region that you are currently in. If you are in several regions, then a list will shown instead.

  • -w <world> can be specified to run this command for a different world or from console
  • -s causes the command to select the region (see /rg select)
  • -u causes UUIDs to be shown rather than player’s last seen names

Example: Showing information about the Global Region

/rg info __global__

List

/rg list [-n] [-p <player>] [-w <world>] [<page>]

Lists the regions that have been created. A number can be provided to show a certain page.

If a player does have permission to list all regions but has permission to list his or her own (ones the player is a member or owner of), then the command will automatically only list the player’s own regions.

  • -w <world> can be specified to run this command for a different world or from console
  • -n causes the command to search only by name rather than UUID and name
  • -p <player> can be specified to filter on regions that the given player is a member or owner of

Example: Listing regions that “sk89q” is a member or owner of

/rg list -p sk89q

Setting Region Options

Flag

/rg flag <id> <flag> [-w <world>] [-g <group>] [-e] [<value>]

Sets a flag on a region (see Region Flags for more information).

To unset a flag, don’t specify a value.

To set a flag to a blank value, use -e. This is useful for setting flags like greeting to a blank message to override the flag set in a different, larger, and lower priority region. If -e is specified in addition to a value, the value is discarded.

  • -w <world> can be specified to run this command for a different world or from console
  • -g <group> specifies the region group (see Region Flags)
  • -e sets an empty value

Example: Setting the pvp flag of “mall” to “deny” with region group “nonmembers”

/rg flag mall pvp -g nonmembers deny

Example: Unsetting the greeting flag on “mall”

/rg flag mall greeting

Example: Setting the greeting flag to an empty value

/rg flag mall greeting -e

Priority

/rg setpriority [-w <world>] <id> <priority>
/rg priority (...)
/rg pri (...)

Sets the priority of a region. See Priority and Inheritance for more information.

The default priority of a region is 0.

  • -w <world> can be specified to run this command for a different world or from console

Parent

/rg setparent [-w <world>] <id> [<parent>]
/rg parent (...)
/rg par (...)

Sets the parent of a region. See Priority and Inheritance for more information.

To unset a parent priority, specify no parent.

  • -w <world> can be specified to run this command for a different world or from console

Example: Setting the parent of “plot1” to “mall”

/rg setparent plot1 mall

Example: Removing the parent of “plot1”

/rg setparent plot1

Miscellaneous Commands

Teleport

/rg teleport [-s] <id>

Teleports yourself to the location specified by either the spawn or teleport flags.

  • -s selects the spawn flag rather than the teleport flag

Note

It is currently not possible to teleport to a region that does not have either of these flags set. Issue WORLDGUARD-2671 to fix this is pending.

Management Commands

Load

/rg load [-w <world>]
/rg reload (...)

Reloads the region data from file or database. If recent changes were made in-game to the region data, this may cause data loss.

The load operation occurs in the background and will not pause the server. If the command is used before a previous load has completed, the new load will be queued. There is a limit to the maximum number of operations that can be queued.

  • -w <world> can be specified to run this command for a different world or from console

Save

/rg save [-w <world>]
/rg write (...)

Saves the region data to disk.

Tip

Region data is saved automatically soon after any changes are made, so this command does not need to be called explicitly.

The save operation occurs in the background and will not pause the server. If the command is used before a previous save has completed, the new save will be queued. There is a limit to the maximum number of operations that can be queued.

  • -w <world> can be specified to run this command for a different world or from console

Migrate Database

/rg migratedb <from> <to>

Migrates from one type of storage driver (see Storage Drivers) to another.

Valid choices for “from” and “to” are:

  • yaml
  • mysql

Migration does not automatically enable the target storage driver – that must be done in the Configuration.

Warning

Be sure to make a backup before running migration.

Warning

This command does not run in the background and will pause the entire server. If your server software has server pause detection, this may kill the server during migration and abort the migration process. If migration is aborted or fails, you may need to empty the target storage before re-running migration.

Migrate UUID

/rg migrateuuid

Converts player names in the region data to Mojang UUIDs.

Names that have no corresponding UUIDs will either be removed or left remaining depending on the Configuration (the setting is keep-names-that-lack-uuids).

Warning

Be sure to make a backup before running migration.

Warning

This command does not run in the background and will pause the entire server. If your server software has server pause detection, this may kill the server during migration and abort the migration process.