WorldBorder

Commands and Permissions

Key: primary command <required value> [optional value]

Note that [worldname] is actually required in the commands below if run from the server console, but optional if run in-game by you as a player, as it then defaults to the world you're in if not specified.


/wb - list available commands like below (show help).

Permission: worldborder.help


/wb set <radiusX> [radiusZ] - set world border of specified radius (in blocks), centered on you. Can only be run by an in-game player. If radiusZ isn't specified, the radiusX value will be used for both.
/wb [worldname] set <radiusX> [radiusZ] <x> <z> - set border with the x and z coordinates of the center specified.
/wb [worldname] set <radiusX> [radiusZ] spawn - set border with the world's spawn point used as the center.
/wb set <radiusX> [radiusZ] player <playername> - set border centered on the specified player for the world they're currently in.
/wb [worldname] setcorners <x1> <z1> <x2> <z2> - set a border based on corner coordinates from location (x1, z1) to (x2, z2).

Permission: worldborder.set (all commands above)


/wb [worldname] radius <radiusX> [radiusZ] - change border radius for this world. The world needs to have already had a border set, since the x and z values are not modified. If radiusZ isn't specified, the radiusX value will be used for both. A "+" or "-" can be added to the start of radiusX or radiusZ to have the current radius increased or decreased a specified amount, for example "+100" would increase the existing border radius by 100 blocks.

Permission: worldborder.radius


/wb [worldname] clear - remove border for this world.
/wb clear all - remove all borders for all worlds.

Permission: worldborder.clear (both commands above)


/wb list - show full border information for all worlds.

Permission: worldborder.list


/wb shape <elliptic|round|rectangular|square> - set the primary border shape to elliptic/round (default), or rectangular/square. Note that "elliptic" and "round" are interchangeable here, as are "rectangular" and "square".

Permission: worldborder.shape


/wb knockback <distance> - how far to move the player back inside the border when they cross it.

Permission: worldborder.knockback


/wb [worldname] fill [freq] [pad] [force] - generate all missing chunks for this world, out to the border. The freq value is the number of times per second it will try to check/generate a chunk (default 20). For a server with players on it, you should probably stick with the default or possibly even a lower value. If you just want it to finish as quickly as possible, try 1000 or so. The pad value is how much of a buffer to add beyond your borders (default 208, should keep any more chunks from being generated by players). Specify "true" for the force value if you want to force loading of all world chunks instead of automatically skipping chunks which are already fully generated. Read below for more info.

Permission: worldborder.fill


/wb [worldname] trim [freq] [pad] - trim off extra chunks for this world, beyond the border. The freq value is the number of chunks per second it will try to check (default 5000). The pad value is how much of a buffer to keep beyond your borders (default 208, should keep any more chunks from being generated by players). Read below for more info.

Permission: worldborder.trim


/wb bypass [player] [on|off] - enable/disable bypass mode for a player, allowing them to go beyond the border without being knocked back. The list of people with bypass mode enabled is stored between server restarts. The specified [player] name is optional if run in-game and defaults to the player running the command if not specified, but is instead required if run from console. [on|off] is optional and will simply toggle if you don't specify "on" or "off".

Permission: worldborder.bypass


/wb bypasslist - outputs a list of all players who have border bypass enabled.

Permission: worldborder.bypasslist


/wb fillautosave <seconds> - set the interval for automatic saving of the world during the Fill process. Default 30 seconds, set to 0 to disable automatic world saving (not recommended).

Permission: worldborder.fillautosave


/wb wshape [worldname] <elliptic|round|rectangular|square|default> - Override the shape for this world only. The world needs to have already had a border set. The default shape used by other worlds (set via /wb shape) will not be changed by this. Note that "elliptic" and "round" are interchangeable here, as are "rectangular" and "square".

Permission: worldborder.wshape


/wb wrap [worldname] <on|off> - toggle border wrapping for the specified world (default off). This will make border crossings in that world send the player around to the opposite edge of the border instead of just knocking them back.

Permission: worldborder.wrap


/wb getmsg - display the message shown to people who cross the border.

Permission: worldborder.getmsg


/wb setmsg <message> - change the border message.

Permission: worldborder.setmsg


/wb delay <amount> - the number of server ticks it will wait between border checks, the default is 5 ticks (250ms); each server tick is roughly 50ms.

Permission: worldborder.delay


/wb whoosh <on|off> - turn knockback "whoosh" effect on or off.

Permission: worldborder.whoosh


/wb portal <on|off> - turn portal redirection on or off (default on). You should normally only need to turn it off if you have problems with Multiverse not creating portals or any other plugin incompatibilities.

Permission: worldborder.portal


/wb denypearl <on|off> - toggle option which cancels ender pearls which are thrown past the border, rather than just adjusting their target location. (default on)

Permission: worldborder.denypearl


/wb dynmap <on|off> - enable/disable DynMap integration. This will show your borders in DynMap, and they should update almost immediately if you change anything about the border. Defaults to true.

Permission: worldborder.dynmap


/wb dynmapmsg <text> - Borders shown in DynMap will have a label with this text. Defaults to "The border of the world."

Permission: worldborder.dynmapmsg


/wb remount <amount> - Set the delay in server ticks before remounting a player to their vehicle after they're knocked back from the border. Defaults to 0, which disables re-mounting and leaves the vehicle next to the player. This value should not be set to a value lower than 10 (the former default value) on a public server as that would lead to client glitches. Even the former default value of 10 has been reported to rarely glitch on some servers, which is why remounting now defaults to disabled.

Permission: worldborder.remount


/wb reload - re-load data from config.yml. Normally should never be needed, but here just in case.

Permission: worldborder.reload


/wb debug <on|off> - turn console debug output on or off. Also should normally never be needed.

Permission: worldborder.debug


Notes:

  • The /wb command is an alias of the main command /wborder, so unless another plugin interferes, you can use /wb and /wborder interchangeably. From the console, you'll of course need to leave off the "/" either way.
  • If as a player you leave out [worldname], it will use the current world you're in; [worldname] is however required from the console.
  • The <radiusX>, <radiusZ>, and <amount> values must be a whole numbers (integers), but <x>, <z>, and <distance> can have a decimal point (they're doubles).
  • A border radius is the distance the border is in each direction from the center (x and z), so for example a radiusX of 600 and radiusZ of 300 would cover a 1200x600 area.

Examples:

/wb set 2000 - Sets a border for the current world with a radius of 2000 (total area 4000x4000 blocks), centered on exactly where you're standing.
/wb set 2000 1000 - As above, but with an X radius of 2000 and a Z radius of 1000 (total area 4000x2000 blocks), making it wider on the X axis than the Z axis.
/wb netherworld set 250 -12.5 47.3 - Sets a border for the world named "netherworld" with a radius of 250 (area 500x500), centered at -12.5 (X) by 47.3 (Z).
/wb shape round - Sets the primary border shape to round/elliptic for all worlds.
/wb wshape square - Sets the border shape for the current world to square/rectangular, not affecting the default shape used by other worlds.


With your permission plugin of choice, you can also use the permission worldborder.* to grant all plugin commands to a group or player. Whether or not you're using a plugin for permissions, Ops and people with access to the server console will be able to use all commands.


The Fill command:

The "fill" command is a bit special, so I'll devote an entire section to describing it. Maybe easier to show than describe, so... Here's a world with a 512 radius round border set, the Before image being from a freshly generated world and the After image being right after WorldBorder's fill command has completed (176 block buffer used here, though 208 is the default):

Before and After Fill

After initiating the fill command, you will receive a bit of info on the process, and will be required to enter /wb fill confirm to actually start the process. Every 5 seconds, it will give you a progress report along with an estimated completion percentage. To pause/unpause the process at any time while it's running, you can use the /wb fill pause command. Likewise, to cancel the process you can use the command /wb fill cancel.
If it detects at any point that you are running extremely low on available memory (less than 200 MB), it will automatically pause the process, and will automatically resume if/when at least 500 MB of memory is available. If you shut down your server while the process is running, it will even mark its progress and will automatically continue on its own as soon as the server comes back up. That being the case, if you want it to finish as quickly as possible and it has hit low memory availability, simply stopping and restarting the server is generally much quicker than waiting for Java to decide to do garbage collection.
It is strongly recommended to only use the default frequency value of 20 for the fill process; higher values have sometimes proven to cause the process to slow to a crawl or crash for no clear reason.


The Trim command:

NOTE: If you are using the DynMap plugin and use our "trim" command, you will need to restart your server afterwards and then run a "fullrender" in DynMap to properly update their map display.

The "trim" command is a complement to the "fill" command, and similarly special. A visual demonstration is in order for it as well. Below is a backup of an old world which was largely unrestrained to begin with, as seen in the Before image. The After image shows it after the "trim" command has been run with a border radius of 750:

Before and After Trim

After initiating the trim command, you will receive a bit of info on the process, and will be required to enter /wb trim confirm to actually start the process. Every 5 seconds, it will give you a progress report along with an estimated completion percentage. To pause/unpause the process at any time while it's running, you can use the /wb trim pause command. Likewise, to cancel the process you can use the command /wb trim cancel.

Facts

Date created
Feb 04, 2013
Last updated
Jul 05, 2016

Author