Skip to content

About

WorldBorder is an efficient, feature-rich Minecraft server plugin that lets server admins set and enforce world boundaries.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

WorldBorder

WorldBorder is an efficient, feature-rich Minecraft server plugin that lets server admins set and enforce world boundaries. It provides knockback/teleport correction, fill/trim utilities to generate or prune chunks, DynMap integration, and various safety options.

Note: This repository follows the original project's BSD license. If you redistribute or fork the project, please keep a link back to the original project as required by the license.

More information and downloads are available on the Spigot resource page:

Install

  1. Build the plugin (or download the released jar from the Spigot resource page).
  2. Place the resulting WorldBorder.jar into your server's plugins/ folder.
  3. Start or restart the server. The plugin will create config.yml and data files inside the plugins/WorldBorder/ folder.

Requirements

  • A Bukkit/Spigot/Paper server compatible with the plugin's api-version.
  • (Optional) DynMap plugin if you want DynMap border visualization.

Configuration

After the first run the plugin creates config.yml in its data folder. Key options you may want to review:

  • message: Message shown to players when they hit the border.
  • round-border: Default shape (true = round/elliptic, false = square/rectangular).
  • knock-back-dist: How many blocks to move players back inside the border.
  • timer-delay-ticks: Frequency of border checks (20 ticks = 1 second).
  • dynmap-border-enabled: Enable DynMap integration.
  • deny-enderpearl: Cancel ender pearls landing beyond border.
  • prevent-block-place / prevent-mob-spawn: Prevent actions outside the border.
  • bypass-list-uuids: UUIDs with bypass enabled.

Per-world border definitions are stored in the plugin's worlds section in config.yml. You can manage borders at runtime using the commands below (no manual editing required unless you prefer it).

Commands

The plugin exposes a single root command wborder (alias wb). Common subcommands and usage:

Command Description
/wborder help Show help pages and usage examples
/wborder set Set a border (can center on player, spawn, or coordinates)
/wborder setcorners <x1> <z1> <x2> <z2> Set border from two corner coordinates
/wborder radius <radiusX> [radiusZ] Change an existing border's radius
/wborder list Show border information for all worlds
`/wborder shape <elliptic rectangular
`/wborder wshape [world] <elliptic rectangular
`/wborder clear [world] all`
/wborder fill [world] [freq] [pad] [force] Generate world chunks inside the border
/wborder trim [world] [freq] [pad] Trim chunks outside the border
/wborder bypass [player] [on/off] Enable or disable bypass for a player
/wborder bypasslist List players with border bypass enabled
/wborder knockback <distance> Set knockback distance for border crossings
/wborder wrap [world] <on/off> Enable/disable wrap-around border crossings
/wborder whoosh <on/off> Toggle knockback visual/sound effect
/wborder getmsg Display the border crossing message
/wborder setmsg <text> Set the border crossing message
/wborder delay <ticks> Set how often border checks run (ticks)
/wborder dynmap <on/off> Enable or disable DynMap border display
/wborder dynmapmsg <text> Set DynMap border label text
/wborder remount <ticks> Delay before remounting a player after knockback
/wborder fillautosave <seconds> Autosave interval during fill process
/wborder portal <on/off> Toggle portal redirection inside the border
/wborder denypearl <on/off> Toggle cancelling of ender pearls beyond border
`/wborder preventblockplace <on off>`
`/wborder preventmobspawn <on off>`
/wborder reload Reload configuration from config.yml
`/wborder debug <on off>`

For full usage and examples of each subcommand consult the plugin help in-game: /wborder help.

Permissions

Permission nodes are prefixed with worldborder.. The main wildcard permission is worldborder.* which grants all WorldBorder permissions when assigned. Most individual command permissions default to op in the bundled plugin.yml.

Permission Description Default
worldborder.* Grants all WorldBorder permissions —
worldborder.bypass Can enable bypass mode to go beyond the border op
worldborder.bypasslist Can list players with border bypass enabled op
worldborder.clear Can remove any border op
worldborder.debug Can enable/disable debug output to console op
worldborder.delay Can set the frequency of border checks op
worldborder.denypearl Can enable/disable cancelling ender pearls beyond border op
worldborder.dynmap Can enable/disable DynMap integration op
worldborder.dynmapmsg Can set the DynMap border label text op
worldborder.fill Can fill missing chunks out to the border op
worldborder.fillautosave Can set autosave interval for fill op
worldborder.getmsg Can view the border crossing message op
worldborder.help Can view command reference help pages op
worldborder.knockback Can set the knockback distance op
worldborder.list Can view a list of all borders op
worldborder.portal Can enable/disable portal redirection inside border op
worldborder.preventblockplace Can prevent block placement outside the border op
worldborder.preventmobspawn Can prevent mob spawning outside the border op
worldborder.radius Can set the radius of an existing border op
worldborder.reload Can force the plugin to reload from the config file op
worldborder.remount Can set remount delay after knockback op
worldborder.set Can set borders for any world op
worldborder.setmsg Can set the border crossing message op
worldborder.shape Can set the default border shape for all borders op
worldborder.trim Can trim map chunks outside the border op
worldborder.whoosh Can enable/disable whoosh knockback effect op
worldborder.wrap Can set border crossings to wrap around op
worldborder.wshape Can set overriding border shape for a world op

Full permission defaults and children are defined in the plugin's plugin.yml (see the permissions section).

Development / Source

This repository contains the plugin source. The plugin is provided under a permissive BSD-style license — see the LICENSE file for full terms.

If you redistribute or fork this project please retain a link back to the original project (for example, the Spigot resource page above) to comply with the license terms.

License

See LICENSE for license terms.

Acknowledgements

  • Original author: Brettflan
  • Previous Forked: This version was forked directly from Brokkonaut's fork, who did an excellent job updating the plugin and colecting other fixes.
  • Maintainer (this fork): Rathinosk — updating the plugin for Minecraft 26.x for use on my personal server farm. I am working to clean up the code, fixing bugs, and improving performance.

About

WorldBorder is an efficient, feature-rich Minecraft server plugin that lets server admins set and enforce world boundaries.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages