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:
Comments
-
Brettflan Owner
-
View User Profile
-
Send Message
Posted Mar 12, 2013Hi there,
On our server we have a specific need : we need the border to be a rectangle at first, and in the coming month we want it to evolve as our "tribe" will move to a new land in unexplored chunks. So, in a longer term, the border will be a polyline, kinda like this image :
Is WorldBorder able to achieve this ?
-
View User Profile
-
Send Message
Posted Mar 11, 2013@Brettflan
Download 7zip file here: Link Removed: http://www.mediafire.com/?uxhwcxlvpsdjjmv
I removed all unneeded server files, left the world folders, and additionally the server properties, and the Mystcraft and TwilightForest mod files, in case you want to take a look.
If you need anything else in the zip, please let me know!
-
View User Profile
-
Send Message
Posted Mar 10, 2013@Blazstyn
Hmm, OK.
Would it be possible for you to create a simple small Mystcraft set of worlds (maybe just 2-3 of them, unexpanded), then zip that up and upload it to Link Removed: http://www.mediafire.com/ or similar upload service and send me the link?
That would give me the definite structure for testing out an update to the Fill and Trim tasks to make sure they're able to handle them.
I'm planning to update Bukkit plugins soon and it would be good to be able to get that done while I'm at it.
-
View User Profile
-
Send Message
Posted Mar 10, 2013@Brettflan
The border monitoring is now working on all worlds, and I messed up - it will complete commands issued in-game to control the border configuration, no problems. Sorry.
Fill & Trim fails to start on these other worlds, that is now the only outstanding issue on my end. Thanks!
-
View User Profile
-
Send Message
Posted Mar 10, 2013@Blazstyn
So... I'm not really understanding that. You're say the border monitoring is now working for all of those worlds now?
I also don't see what's happening based on that screenshot. It looks like you tried to do something with two world names which didn't have borders set ("world_myst" and "world_myst/age4"), and then you had it list the current borders where a different one ("world_myst\age12") showed as being correctly set. Please clarify.
-
View User Profile
-
Send Message
Posted Mar 10, 2013@Brettflan
That will be a fantastic addition! Future-proofs the plugin, ya know?
With a fresh config, the border detection task works in the TwilightForest and also Mystcraft ages. However, after setting the border in the Mystcraft Ages, I cannot remove it from them (using a variety of names to try, see below):
Do you reckon the render task will perform correctly given the variety of terrain generation provided with all these other mods? Initially I thought the problem could have been due to a generation task that WB couldn't understand. I look forward to testing out the build with the new Fill & Trim task abilities!
-
View User Profile
-
Send Message
Posted Mar 10, 2013@Blazstyn
I might update the world region files finder for the Fill and Trim tasks to check in any folder that starts with "DIM" inside the world folder, to support custom world types.
For the borders not working in those worlds, try enabling debug mode (/wb debug on) to see if anything is output when you go outside where the border should be.
-
View User Profile
-
Send Message
Posted Mar 9, 2013@Brettflan
Okay.. Hope this is understandable: Mystcraft creates a directory at the same level as all the other world directories called 'world_myst', which contains additional directories 'age1', 'age2', 'age3', etc... as the Myst Ages - essentially additional worlds - are generated. Inside each Age directory is:
So: Minecraft_Server/world_myst/age12/DIM_MYST12
The TwilightForest mod by default takes DIM7. It will not render using WB.
So: Minecraft_Server/world_twilightforest/DIM7
As for the border-checking task failure, I don't see any feedback from the server. The borders I set in-game and then from the console. WB indicated that it did save the config file. I presume it is just not picking up on players within the worlds as they are loaded differently? New naming scheme, or perhaps it is just that they are not added by bukkit, but by Forge.
Thanks!
-
View User Profile
-
Send Message
Posted Mar 9, 2013@HopTownCraft
Trim deletes chunks, yes. They can later be recreated normally.
-
View User Profile
-
Send Message
Posted Mar 9, 2013I did wanna ask. What happen if you trim the world using world border. Are the chunks deleted ? What if they are deleted? Are they going to regenerate with weird chunks? or smoothly linked chunks?
-
View User Profile
-
Send Message
Posted Mar 9, 2013I wonder if it'd be possible to create a 'wrapped' world. Probably not with WorldBorder, but one could, for chunks over the border, send chunks from the opposite side of the map, and then, on crossing the border, be quietly teleported over.
-
View User Profile
-
Send Message
Posted Mar 9, 2013@JordiAB
If it's like it was doing before with only boats (nothing else), then not really. That's a problem with the client or CraftBukkit server. According to the CraftBukkit server the player is moved correctly back inside the border and it treats them accordingly, while in the client they see themselves as still being outside the border. So when a plugin like this one then checks their location coordinates, the server says they're inside the border where they were supposedly teleported. Nothing I can do about that.
@Blazstyn
What are the name of the DIM folders for those worlds? The exact string used in the folder name.
As for the border detection, I don't see why that wouldn't be working. Did you create those borders in-game or through the console? Note that the name needs to be exactly correct, including capitalization. If it's still not working, those worlds must not be recognizable through Bukkit or something.
@ziryuk
For a mid-sized server I'd start around 2000 radius. You can always increase it later if it's too small. Decreasing the size is more troublesome since you might be cutting off areas players have already built in further out.
-
View User Profile
-
Send Message
Posted Mar 8, 2013@Brettflan Sorry I was a bit confused because /wb kept bringing up a workbench because of Essentials.
Can you or anyone give me a recommended radius size for a 20-25 slot server? I'm currently doing 7000 but Im having second thoughts.
-
View User Profile
-
Send Message
Posted Mar 8, 2013Hey there! Fantastic plugin. Use it, always.
Just set up an FTB server and the border detection doesn't seem to initialize for TwilightForest worlds or other Ages. Basically, everything other than world, world_nether, and world_the_end are not protected by a border.
Additionally, the generation task will not run as the DIM number is different for these other worlds - they are added by mods.
I had a look through the config and plugin configs, but there's no options for any additional worlds. Would there be any way to configure WB to work alongside these mod-added worlds?
-
View User Profile
-
Send Message
Posted Mar 8, 2013There is a big bug. Mounts to pigs and can pass the edge being in them! Help!
-
View User Profile
-
Send Message
Posted Mar 8, 2013@ziryuk
Read above.
-
View User Profile
-
Send Message
Posted Mar 8, 2013Hey whats the command to generate all chunks 'inside' the border?
-
View User Profile
-
Send Message
Posted Mar 8, 2013@WayGroovy
I don't have the time or inclination to code a feature like that myself, but if another dev wants to, I accept reasonable decently-written pull requests which are tested and don't cause problems with existing features.
-
View User Profile
-
Send Message
Posted Mar 7, 2013What would it take to get a feature request or fork put in?
I'd like to integrate vault economy with world border such that players can spend in game currency to increase the border of the world they are in...
I am not a java dev nor do I have a clue what this would entail. I'd like the price to be based somewhat on the number of blocks the expansion would entail.
-
View User Profile
-
Send Message
Posted Mar 7, 2013@deleted_8537216
Hmm. Not a bad idea.
@stapleshotz
/wb fill cancel, as covered in the info linked above and for that matter in the info given when you run the /wb fill command in the first place.