Skip to content

Commit

Permalink
Updated config.yml to make WBAPI the default. Fixed typos in Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
tastybento committed Feb 28, 2021
1 parent f27cd54 commit d3a8147
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_Border&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_Border)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_Border&metric=security_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_Border)

Border puts a border around player's islands.
**Border** shows a world border around islands. The world border is the Minecraft world border and players cannot go outside of it or a barrier block border that can show up when required.

Features:
##Features##

* Minecraft vanilla world border (requires WorldBorderAPI plugin - see below)
* Alternative barrier blocks border - can block transit or just show where the border is using particles.
Expand All @@ -27,10 +27,10 @@ By default, Border will operate in all game mode worlds on the BentoBox server.
- BSkyBlock
```

### Use WorldBorderAPI (WABI)
### Use WorldBorderAPI (WBAPI)
If you want to use the vanilla world border then you must download the WorldBorderAPI plugin. You can find them here: https://github.com/yannicklamprecht/WorldBorderAPI/releases

Players cannot exit past the vanilla world border, so it will completely block movement outside of a player's protected island area. If you do not want this, then do not use WABI.
Players cannot exit past the vanilla world border, so it will completely block movement outside of a player's protected island area. If you do not want this, then do not use WBAPI.

To activate WABI, set this to true in the config.yml:

Expand All @@ -39,7 +39,7 @@ use-wbapi: true
```

### Use barrier blocks.
This only applies if you are not using WABBI.
This only applies if you are not using WBAPI.

If true, the the border will use barrier blocks to prevent most players from exiting the border. If players do manage to exit it, they will get teleported back inside it.

Expand Down
20 changes: 12 additions & 8 deletions src/main/resources/config.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
#
# This list stores GameModes in which the addon should not work.
# To disable the addon it is necessary to write its name in new line that starts with -. Example:
#
# This list stores GameModes in which Border addon should not work.
# To disable addon it is necessary to write its name in new line that starts with -. Example:
# disabled-gamemodes:
# - BSkyBlock
disabled-gamemodes: []

#
# Use vanilla world border. Requires WorldBorderAPI plugin.
# Download from https://github.com/yannicklamprecht/WorldBorderAPI/releases
use-wbapi: true
#
# Use barrier blocks. If false, the border is indicated by particles only.
# Only applicable if vanilla world border is not used
use-barrier-blocks: true

#
# Default border behavior
show-by-default: true

# Show max-protection range border. This is a visual border only and not a barrier
#
# Show max-protection range border. This is a visual border only and not a barrier.
show-max-border: true

0 comments on commit d3a8147

Please sign in to comment.