Border#

Border can create and show a border around islands which players cannot pass.
The border can be:

• the vanilla world border
• a custom border that shows up when the player is near (visuals can be configured).

Created and maintained by tastybento.

Installation#

1. Restart the server (to enable the addon and have the config.yml file generated)
2. Put the addon jar into the plugins/BentoBox/addons folder
3. Customize settings in config.yml (optional)
4. Restart the server to apply new settings

Commands#

border#

Command: /[player command] border
Description: Turns the border on/off.
Permission: [gamemode].border.toggle. Default: op.
Notes: Since Version 3.0.0 it requires a permission.

border type#

Command: /[player command] border type {barrier | vanilla}
Description: Sets the border type. Run with no argument to toggle between the available types.
Permission: [gamemode].border.type. Default: true.
Example: /[player command] border type barrier

border color#

Command: /[player command] border color {red | green | blue}
Description: Sets the vanilla world border color for the player. Only applies when using the vanilla border type.
Permission: [gamemode].border.color.red, [gamemode].border.color.green, [gamemode].border.color.blue (or [gamemode].border.color.* for all). Default: op.
Example: /[player command] border color green

Configuration#

The config.yml file contains settings.
The default value is usually the example value unless explicitly stated.

Disable game modes#

You can disable the addon with this setting.
By default, Border will operate in all game mode worlds on the BentoBox server.

You can disable a game mode by writing its name on a new line that starts with -.
Example to disable BSkyBlock:

disabled-gamemodes:
  - BSkyBlock

Default value:

disabled-gamemodes: []

Border type#

The default kind of border new players get. There are two choices:

• VANILLA — uses Minecraft's own round world-border effect (the wobbly wall you see in the vanilla game). It can be tinted a colour.
• BARRIER — uses invisible barrier blocks and coloured particles that only appear as you get close to the edge.

Players who have permission can switch their own border with /[player command] border type. If they don't have permission, they get whatever you set here.

type: VANILLA

Vanilla border colour#

The colour of the vanilla world border. Only used when the border type is VANILLA.
Choices are RED, GREEN, or BLUE. Players with permission can pick their own colour with /[player command] border color.

color: BLUE

Bounce items back#

If true, items a player throws at the border are bounced back inside instead of flying out. Set to false to let thrown items pass through.

bounce-back: true

Return teleport#

Controls whether if players somehow manage to pass through the border (e.g. teleport in the same world), should they be teleported back to their islands.

Set to true if you want players to be teleported back.

Warning: If you set this value to false along with having use-barrier-blocks as false, players will be able to just simply walk through the border.

return-teleport: true

use-barrier-blocks: false
return-teleport: false

Return teleport safety block#

Only used when return-teleport is true. If a player gets teleported back inside the border and lands somewhere unsafe (for example over a drop or in lava), this places a safe block under their feet so they don't get hurt.

return-teleport-safety-block: true

Use barrier blocks.#

Only applies for players who are not using the vanilla border type.

• true: the border will be made of barrier blocks.
• false: there will be no barrier block-based border. This means it is up to the return-teleport setting whether players are teleported back when leaving the island.

use-barrier-blocks: true

Default border behavior#

Players can turn the border on and off with a command if they have the right permission.
This setting makes the default on or off; set it to true to have it on by default.

show-by-default: true

Show max-protection range border.#

Only applies for players who are not using the vanilla border type.

Set to true to show barrier (🚫) particles shown at the max protection range.
This is useful for game modes like Boxed where the player's protection area can move around.

Note that these are not barrier blocks but particles, so the "air" just looks like them.

show-max-border: true

Show particles#

Enables/disables all types of wall particles shown by the addon (border and max-protection range particles).

Set to false if you don't want any wall particles to be shown.

show-particles: true

Barrier offset#

Only applies for players who are not using the vanilla border type.

Normally the border sits exactly at the edge of the player's protection range. This setting pushes the barrier outwards by the number of blocks you give it, so players can walk a bit past their protected area before hitting the wall.

Important things to know:

• It does not make the protected area bigger — players still can't build or protect the extra space, they can only stand in it.
• The border will never go further out than the island distance, no matter how big a number you set.
• The minimum (and default) value is 0, which means the border sits right on the protection range.

barrier-offset: 0

Placeholders#

FAQ#

use-barrier-blocks: false
return-teleport: false

Changelog#

Translations#

Source#

Want to contribute? See this documentation's source code at GitHub.