WorldBorder
Further releases for Spigot 1.13+ are now being posted on the Spigot site. I do not plan to release any further updates here on BukkitDev.
- Full list of Commands and Permissions
- Changelog
- Further Miscellaneous Information
- Source available on GitHub
- Old discussion on main Bukkit forum
If you appreciate this plugin and actually want to see it developed further by me rather than only receiving compatibility updates, you are welcome to .
Thanks to the following people who have been kind enough to donate: jonDatz, xrobau, Gussi, Dizzy, R. Meijer, FoundationCraft, T. Bronner, R. Thompson, The Pokemon Server, legitplay.net, D. Senff, Vik1395, TagCraftMC, D. Strickner, M. Wilson, Rhythmatic, W. Downey, P. V. Gretener, MiniCraft Server, Cosmic Craft, ScarcityFree.com, polaris_iv (Forge port), matagin, T. Ahokas.
Also thanks to IMathe172I (Lang Lukas) for contributing code to support elliptic and rectangular border shapes, and Indiv0 for contributing code to support border wrapping.
Description
This plugin is intended to efficiently provide a border for each of your worlds, which only people granted special bypass access are allowed beyond. These borders can be round/elliptic or square/rectangular. As the plugin has been written with performance as the most important goal, it should have no performance impact on your server. Additional world trimming and filling commands are available as well.
Older plugins which originally inspired the creation of this one: rBorder and BorderGuard.
Features
- You can set up a separate border for each world, but only one border per world.
- You can have either round/elliptic or square/rectangular borders. Square/rectangular borders are slightly higher performance, round/elliptic borders make for nicer display maps. Different worlds can have different border shapes if you so choose.
- Configuration and border setup is done completely using commands in-game or through the server console. No need to ever edit the config file directly.
- Support for all permission plugins which interface with Bukkit's built-in "superperms" permission system.
- You can fully generate (fill) your world all the way to the border, filling in any missing chunks, including a configurable buffer zone just outside your border.
- You can trim off any world chunks beyond the border, getting rid of extraneous parts, with a configurable buffer zone left just outside your border.
- You can use a bypass command to allow specific players to go beyond all borders.
- Borders can be automatically displayed in DynMap if you use that plugin.
- All plugin data is automatically saved whenever any borders or settings are changed.
- If a player crosses a border while in a vehicle, the momentum of the vehicle is stopped and it is moved back inside the border with the player.
- When a player is moved back inside a border, they will be moved to a safe vertical location if needed.
- Borders for specific worlds can be set to wrap around instead of just knocking back players who cross the border, instead sending them to the opposite edge of the border.
English Tutorial:
Spanish Tutorial:
Of special interest are the Fill command and the Trim command features:
Borders are also displayed automatically by default in DynMap if you have it:
@domingo15
The region files which are completely outside the border will be deleted. The region files which contain chunks which are still inside your border will have the outside chunks marked as nonexistent. If any chunks are loaded in a region which is to be deleted, it might be locked by your OS and you'll be notified of that if so during the trim process. Better to run the trim process after stopping and starting the server back up if you're worried about it.
The region files in question will indeed be deleted from the region folder, as that's where they are.
@Brettflan
what happen if i fill an entire area example: 1000 border then reduce it back to 500 then trim the excess 500 from the 1000, do the loaded files from filling the 1000 be deleted from the region folder on the worlds folder?
@smokie23
It gets rid of any chunks outside the border (with a configurable buffer zone), no matter how far or close they are.
Have a quick question. Will this trim option get rid of the chunks thats are off in the distance? or will they create whole new 'fill areas'?
<img src=http://www.ariongaming.com/images/minecraft/output.png alt=output.png>
It doesn't get said often enough: Brettflan, you rock.
The border on dynmap is a cool feature, but it would be even cooler if it was an option per world rather than a global on/off :) thanks for the feature though! certainly makes the world more understandable to players :P
@Pandamatak
World generation methods are from Bukkit, so the world will generate the same as if someone had simply walked around the entire area. Strongholds and every other little detail included.
How does this fare with finding strongholds since there are only three in a given world? Does it spawn at least one in the defined border?
@Infuscu
It was changed because thorough testing done several months ago showed the performance difference to be miniscule, and most people prefer round borders.
Thanks for pointing out that text needed to be updated.
EDIT: The editor sucks, I tried to highlight it but with limited success! Anyway, what is the default shape of the map?
Contradictory ..
_Under Commands
/wb shape round - set the border shape to "round" (default).
/wb shape square - set the border shape to "square".
_Under Further Information
The default border shape is "square". This is the more lightweight option and should cause practically no impact on server performance. A "round" border makes for a nicer world map, but takes a few more calculations. Even so, the "round" border is only very slightly more taxing; it is based mostly on rBorder's excellently crafted algorithm for determining if a player is inside the border.
Question: Why was it changed? Is the performance 'issue' not present anymore?
I'd like to be able to customize the thick red border, maybe using dynmap's style syntax somewhere. Thanks :)
Much love for WorldBorder!
@Brettflan
Thank you - it works now. The cache was the problem. I had to clear the website-cache, restart Firefox and do a Strg-F5. Now it works.
@lfrst05
Sounds like you /web/ files are outdated, somehow. If they were up-to-date, only clicking on the border itself would bring up the label.
Actually, if that's not the case, it's probably your browser caching old copies of the Javascript files used by dynmap which draw the markers. Try clearing your browser cache.
The dynmap feature is great! But I have one problem. When i click anywhere inside the border on the map the label is shown. Is the any way to show the label only when you click on the red line or to disable it completely?
Released v1.5.4
New commands:
/wb dynmap <on/off> - turn DynMap border display on or off.
/wb dynmapmsg <text> - DynMap border labels will show this.
New permissions:
worldborder.dynmap (Op): Can enable/disable DynMap border display integration
worldborder.dynmapmsg (Op): Can set the label text for borders shown in DynMap
@Spiritwo13
Rectangular / ellipsoid border shapes are not planned, sorry. If someone else felt like implementing them, the plugin is open source and I accept reasonable pull requests.
You should integrate a feature that is similar to the plugin BorderArea, which allows for you two set two rectangular points and have that rectangle be the border. This would allow for rectangular shaped borders as well. At least personally I think that rectangular shapes make for a better map shape than a square.
@Anthony45654
Didn't you read the info that came up between using /wb fill and /wb fill confirm? It told you there you can use /wb fill pause and /wb fill cancel. You'd also see those commands mentioned if you read the info posted above in the plugin information.
Any way how I can stop the plugin from filling?