Skip to content

Border#

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

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

Created and maintained by tastybento.

Dependencies

This addon is configured by default to use the WorldBorderAPI to show the border, but it can be turned off, see the use-wbapi setting.

Installation#

  1. Restart the server (to enable the addon and have the config.yml file generated)
  2. If you want to enable the vanilla border type, put the WorldBorderPlugin jar into the plugins folder and make sure to set use-wbapi: true in config.yml. Otherwise, set use-wbapi: false in the configuration.
  3. Put the addon jar into the plugins/BentoBox/addons folder
  4. Customize settings in config.yml (optional)
  5. Restart the server to apply new settings

Commands#

Tip

[player_command] is a command that differs depending on the gamemode you are running. The Gamemodes' config.yml file contains settings that allows you to modify this value. As an example, on BSkyBlock, the default [player_command] is island.

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.
Permission: [gamemode].border.set-type. Default: true.
Example: /[player command] border type barrier

Tip

[gamemode] is a prefix that differs depending on the gamemode you are running. The prefix is the lowercased name of the gamemode, i.e. if you are using BSkyBlock, the prefix is bskyblock. Similarly, if you are using AcidIsland, the prefix is acidisland.

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: []

Use WorldBorderAPI (WBAPI)#

Enables or disables the usage of WorldBorderAPI.
If you want to use it then download and enable the WorldBorderAPI plugin.

Set it to true to enable (and require) the WBAPI integration.

use-wbapi: 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

Tip

If you want to use this addon only to show the borders for the players, use the following settings:

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

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

Translations#

We need your help!

A vast majority of strings in BentoBox and its addons can be translated into virtually any language. However, most of the translations that are provided with BentoBox or said addons are made by the community, on which we heavily rely. We cannot review all the content of these translations nor guarantee its quality, hence why we highly appreciate any contributions.

  • If your language is not available for this addon or if you would like to improve the existing translation, please read the translation guidelines and start translating!
  • If your language is not listed below, please contact us on Discord and we will setup everything so that you can start translating!
Available Language Language code Progress
English (United States) en-US 100% (Default)
Chinese (China) zh-CN progress
Chinese (Hong Kong) zh-HK progress
Chinese (Taiwan) zh-TW progress
Croatian hr progress
Czech cs progress
French fr progress
German de progress
Hungarian hu progress
Indonesian id progress
Italian it progress
Japanese ja progress
Korean ko progress
Latvian lv progress
Polish pl progress
Portuguese pt progress
Romanian ro progress
Russian ru progress
Spanish es progress
Turkish tr progress
Vietnamese vi progress

Source#

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


Last update: November 29, 2021 09:11:12