Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-22 02:35:21 +01:00
Code Issues Projects Releases Wiki Activity

updated for 1.6.0

Florian CUNY 2019-08-13 13:46:01 +02:00
parent 0f19e503ce
commit 91e72307b0
1 changed files with 19 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
Placeholders.md

@ -1,4 +1,4 @@
Placeholders allow you to display data from any of BentoBox's addons and gamemodes on other plugins!
Placeholders allow you to display data from any BentoBox's addons or gamemodes in other plugins. And the opposite is true as well!
## How to use the placeholders?
@ -6,15 +6,17 @@ Placeholders allow you to display data from any of BentoBox's addons and gamemod
As of 1.5.0, BentoBox supports both [**PlaceholderAPI**](https://www.spigotmc.org/resources/placeholderapi.6245/) and [**MVdWPlaceholderAPI**](https://www.spigotmc.org/resources/mvdwplaceholderapi.11182/).
We **highly recommend that you use PlaceholderAPI**. However, plugins from MVdW (such as *Featherboard*) incite you heavily to use MVdWPlaceholderAPI. Yet, you should note that **MVdWPlaceholderAPI provides us less flexibility with our placeholders that PlaceholderAPI**. As such, we may provide **limited support** with issues related to MVdWPlaceholderAPI.
We **highly recommend that you use PlaceholderAPI**. In facts, MVdWPlaceholderAPI provides us with way less flexibility with our placeholders than PlaceholderAPI does. As such, we may provide **limited support** for issues related to MVdWPlaceholderAPI.
### Launch the server and you're ready to go!
Regardless of the placeholder API you're using, there are no more steps than just launching the server. There are **no expansions to download**: BentoBox handles everything else!
Regardless of the placeholder API you're using, just start the server. There are **no expansions to download**: BentoBox handles everything!
## How to display a placeholder in the chat with EssentialsChat?
## How to display a placeholder in the chat?
If you're using **EssentialsChat** and **PlaceholderAPI**, you **must** install [**ChatInjector**](https://www.spigotmc.org/resources/chatinjector.38327/) in order for placeholders to show up in the chat. Although ASkyBlock was supporting this natively, it was at the cost of a support burden for us developers (it was unstable). That's why we decided not to port this feature into BentoBox.
If you're using **EssentialsChat** and **PlaceholderAPI**, you **must** install [**ChatInjector**](https://www.spigotmc.org/resources/chatinjector.38327/) in order for the placeholders to show up in the chat.However, please note it has been reported that ChatInjector might cause issues.
We recommend you to use an alternative chat plugin which supports PlaceholderAPI, such as [**ChatControl**](https://www.spigotmc.org/resources/chatcontrol%E2%84%A2-the-ultimate-chat-plugin-500-000-downloads-1-2-5-1-14-4.271/).
## How to suggest a new placeholder?
@ -24,21 +26,9 @@ If you think a placeholder for BentoBox or another default placeholder for gamem
As of [BentoBox 1.4.0](https://github.com/BentoBoxWorld/BentoBox/releases/tag/1.4.0), all gamemode addons get some default placeholders automatically registered to them.
### 1.4.0
| Placeholder | Description |
|-----------------------------------------------|--------------------------------------------------|
| %bentobox_[gamemode]-world-friendlyname% | Name of the gamemode's world |
| %bentobox_[gamemode]-island-distance% | Distance between islands of the gamemode's world |
| %bentobox_[gamemode]-island-protection-range% | Size of the island's protection range |
| %bentobox_[gamemode]-island-owner% | Name of the island's owner |
| %bentobox_[gamemode]-island-creation-date% | Creation date of the island |
| %bentobox_[gamemode]-island-spawnpoint% | Coordinates of the island's spawnpoint (?) |
| %bentobox_[gamemode]-island-name% | Name of the island |
As of [1.5.0](https://github.com/BentoBoxWorld/BentoBox/releases/tag/1.5.0), changes were made (and some placeholders added) to ensure a more fluent and convenient usage of these placeholders.
### 1.5.0 and above
As of 1.5.0, changes were made (and some placeholders added) to ensure a more fluent and convenient usage of these placeholders.
**Available default placeholders in 1.5.2.**
**Available default placeholders in 1.6.0.**
| Placeholder | Description | Version |
|-------------------------------------------------------|--------------------------------------------------------------------------------|-----------|
@ -50,7 +40,6 @@ As of 1.5.0, changes were made (and some placeholders added) to ensure a more fl
| %[gamemode]_island_protection_range_diameter% | Diameter of the island's protection range | 1.5.0 |
| %[gamemode]_island_owner% | Name of the island's owner | 1.4.0 |
| %[gamemode]_island_creation_date% | Creation date of the island | 1.4.0 |
| ~~%[gamemode]_island_spawnpoint%~~ | ~~Coordinates of the island's spawnpoint (?)~~. **Will be removed in 1.6.0.** | ~~1.4.0~~ |
| %[gamemode]_island_name% | Name of the island | 1.4.0 |
| %[gamemode]_island_center% | Coordinates of the island's center | 1.5.0 |
| %[gamemode]_island_center_x% | X coordinate of the island's center | 1.5.0 |
@ -82,50 +71,13 @@ As of 1.5.0, changes were made (and some placeholders added) to ensure a more fl
| %[gamemode]_resets% | Number of times the player has reset his island | 1.5.0 |
| %[gamemode]_resets_left% | Number of times the player can reset his island | 1.5.0 |
## Addons placeholders
<table align='center'>
<tr>
<td align='left'><b>Addon</b></td>
<td align='left'><b>Location</b></td>
</tr>
<tr>
<td align='left' nowrap=nowrap>AcidIsland GameMode</td>
<td align='left' nowrap=nowrap>[[Wiki Page|https://github.com/BentoBoxWorld/AcidIsland/wiki/Placeholders]]</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>BSkyBlock GameMode</td>
<td align='left' nowrap=nowrap>[[Wiki Page|https://github.com/BentoBoxWorld/BSkyBlock/wiki/Placeholders]]</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>CaveBlock GameMode</td>
<td align='left' nowrap=nowrap>[[Wiki Page|https://github.com/BentoBoxWorld/CaveBlock/wiki/Placeholders]]</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>SkyGrid GameMode</td>
<td align='left' nowrap=nowrap>[[Wiki Page|https://github.com/BentoBoxWorld/SkyGrid/wiki/Placeholders]]</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>Biomes Addon</td>
<td align='left' nowrap=nowrap>Not Implemented</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>Challenges Addon</td>
<td align='left' nowrap=nowrap>Not Implemented</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>GreenHouses Addon</td>
<td align='left' nowrap=nowrap>Not Implemented</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>Level Addon</td>
<td align='left' nowrap=nowrap>[[Wiki Page|https://github.com/BentoBoxWorld/Level/wiki/Placeholders]]</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>Limits Addon</td>
<td align='left' nowrap=nowrap>Not Implemented</td>
</tr>
<tr>
<td align='left' nowrap=nowrap>Welcome Warp Sign Addon</td>
<td align='left' nowrap=nowrap>Not Implemented</td>
</tr>
</table>
## See also
Gamemodes and Addons can also bring their own placeholders. We highly recommend that you look up the following pages, which are likely more adapted to your needs.
* Gamemodes
* [AcidIsland](https://github.com/BentoBoxWorld/AcidIsland/wiki/Placeholders)
* [BSkyBlock](https://github.com/BentoBoxWorld/BSkyBlock/wiki/Placeholders)
* [CaveBlock](https://github.com/BentoBoxWorld/CaveBlock/wiki/Placeholders)
* [SkyGrid](https://github.com/BentoBoxWorld/SkyGrid/wiki/Placeholders)
* Addons
* [Level](https://github.com/BentoBoxWorld/Level/wiki/Placeholders)