diff --git a/Placeholders.md b/Placeholders.md index f8030c2..29cff9f 100644 --- a/Placeholders.md +++ b/Placeholders.md @@ -1,53 +1,56 @@ -Placeholders allow you to display data from PlotSquared in other plugins using FeatherBoard or PlaceholderAPI. -## How to use placeholders? +# Overview +Placeholders allow you to display data from PlotSquared in other plugins. For example with [FeatherBoard](https://www.spigotmc.org/resources/featherboard.2691) you can create a scoreboard (sideboard) with the info about the plot you're standing on. -### Download the placeholder API you need. +Furthermore, PlotSquared support placeholders from other plugins too. -As of 5.0, PlotSquared natively supports [**PlaceholderAPI**](https://www.spigotmc.org/resources/placeholderapi.6245/) and [**MVdWPlaceholderAPI**](https://www.spigotmc.org/resources/mvdwplaceholderapi.11182/). +# How to use placeholders -### Launch the server and you're ready to go! +PlotSquared has explicit and official support for [**PlaceholderAPI**](https://www.spigotmc.org/resources/placeholderapi.6245/) and [**MVdWPlaceholderAPI**](https://www.spigotmc.org/resources/mvdwplaceholderapi.11182/). -Regardless of the placeholder API you're using, just start the server. There are **no expansions to download**: PlotSquared handles everything internally! +> **Warn:** For the PlotSquared placeholders you don't need to download an PAPI expansion. As opposed to some other plugins, PlotSquared handles everything internally. -## How to display a placeholder in the chat? +# Tips for using placeholders in other plugins -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. +## Chat-System -We recommend you to use an alternative chat plugin which supports PlaceholderAPI, such as [**DeluxeChat**](https://www.spigotmc.org/resources/deluxechat.1277/). -To display them via PlaceholderAPI use the following format: `%plotsquared_%` -To display them via FeatherBoard use the following format: `{placeholderapi_plotsquared_}` +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. -## How to suggest a new placeholder? +We recommend you to use an alternative chat plugin which supports **PlaceholderAPI**, such as [**DeluxeChat**](https://www.spigotmc.org/resources/deluxechat.1277/). -If you think a placeholder for PlotSquared should be added, then please submit us a [placeholder request](https://github.com/IntellectualSites/PlotSquaredSuggestions/issues/new/choose). +# PlotSquared placeholders -**Available placeholders in 5.0** +> **Tip:** If you think a placeholder for PlotSquared should be added, then please check then please [raise an an issue here](https://github.com/IntellectualSites/PlotSquared/issues/new/choose). + +*Available placeholders in 5.0:* | Placeholder | Description | |-------------------------------------------------------|--------------------------------------------------------------------------------| -| %plotsquared_currentplot_alias% | Alias of the plot | -| %plotsquared_currentplot_owner% | Owner of the plot | -| %plotsquared_currentplot_members% | Amount of players added and trusted to the plot | -| %plotsquared_currentplot_members_added% | Amount of players added to the plot | -| %plotsquared_currentplot_members_trusted% | Amount of players trusted to the plot| -| %plotsquared_currentplot_members_denied% | Amount of members denied from the plot | -| %plotsquared_world_name% | Get the name of the world | -| %plotsquared_has_plot% | Displays true or false whether the player has plot | -| %plotsquared_has_plot_(world)% | Displays true or false whether the player has plot in a specific world | -| %plotsquared_has_build_rights% | Displays true or false whether the player has build rights on the plot | -| %plotsquared_plot_count% | Amount of global plots of a player | -| %plotsquared_plot_count_(World)% | Amount of plots for a player in a specific world | -| %plotsquared_allowed_plot_count% | Amount of maximum plots a player can have | -| %plotsquared_currentplot_xy% | Displays the X and Y ID of a plot | -| %plotsquared_currentplot_x% | Displays the X ID of a plot | -| %plotsquared_currentplot_y% | Displays the Y ID of a plot | -| %plotsquared_currentplot_rating% | Displays the average rating of a plot | -| %plotsquared_currentplot_biome% | Displays the biome of a plot | - +| `%plotsquared_currentplot_alias%` | Alias of the plot | +| `%plotsquared_currentplot_owner%` | Owner of the plot | +| `%plotsquared_currentplot_members%` | Amount of players added and trusted to the plot | +| `%plotsquared_currentplot_members_added%` | Amount of players added to the plot | +| `%plotsquared_currentplot_members_trusted%` | Amount of players trusted to the plot| +| `%plotsquared_currentplot_members_denied%` | Amount of members denied from the plot | +| `%plotsquared_world_name%` | Get the name of the world | +| `%plotsquared_has_plot%` | Displays true or false whether the player has plot | +| `%plotsquared_has_plot_(world)%` | Displays true or false whether the player has plot in a specific world | +| `%plotsquared_has_build_rights%` | Displays true or false whether the player has build rights on the plot | +| `%plotsquared_plot_count%` | Amount of global plots of a player | +| `%plotsquared_plot_count_(World)%` | Amount of plots for a player in a specific world | +| `%plotsquared_allowed_plot_count%` | Amount of maximum plots a player can have | +| `%plotsquared_currentplot_xy%` | Displays the X and Y ID of a plot | +| `%plotsquared_currentplot_x%` | Displays the X ID of a plot | +| `%plotsquared_currentplot_y%` | Displays the Y ID of a plot | +| `%plotsquared_currentplot_rating%` | Displays the average rating of a plot | +| `%plotsquared_currentplot_biome%` | Displays the biome of a plot | +| `%plotsquared_currentplot_localflag_%` | Display the value of the flag set on current plot | +| `%plotsquared_currentplot_flag_%` | Display the value of the flag set on current plot or if it's not set: display the inherited flag value (worlds.yml) | # Use PlaceholderAPI placeholders in PlotSquared -PlotSquared messages and flags support PlaceholderAPI placeholders. The only requirement is that [PAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is installed on the server. +PlotSquared messages and flags support PlaceholderAPI placeholders. The only requirement is that [**PlaceholderAPI**](https://www.spigotmc.org/resources/6245/) is installed on the server. As an example, using `/plot flag set greeting Welcome %player_name%` will send the message "Welcome Steve" when the player Steve enters a plot. -This feature can be completely disabled in `settings.yml`. A list of available placeholders can be found [here](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders). \ No newline at end of file +A list of available placeholders can be found [here](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders). + +> **Tip:** This feature can be completely disabled in `settings.yml`. \ No newline at end of file