# Placeholders ## Introduction {% hint style="info" %} The placeholder integration allows you to display data from other plugins in specific locations in PlotSquared. {% endhint %} For example, with [FeatherBoard](https://www.spigotmc.org/resources/2691) you can create a scoreboard (sideboard) with the info about the plot you're standing on. And with using [PlaceholderAPI](https://www.spigotmc.org/resources/6245), you can do `/plot flag set greeting Welcome %player_name%` which translates to "Welcome Steve" when the player Steve enters a plot. + The `Player` expansion from PlaceholderAPI is required to be installed. Currently, (FeatherBoard and) PlaceholderAPI placeholders, can be used in the `greeting` and `farewell` flag of a plot. ## Setup PlotSquared has explicit and official support for [PlaceholderAPI](https://www.spigotmc.org/resources/6245) and [MVdWPlaceholderAPI](https://www.spigotmc.org/resources/11182). Follow the instruction of these placeholder systems to install it correctly. {% hint style="info" %} For the PlaceholderAPI placeholders of PlotSquared you don't need to download a PAPI expansion. As opposed to some other plugins, PlotSquared handles everything internally. {% endhint %} ## Placeholder Deactivation in PlotSquared Placeholders can be turned off in `settings.yml`: ```yaml external-placeholders: false ``` ## Tips for specific plugins ### Chat-System If you're using **EssentialsChat** and **PlaceholderAPI**, you must install [ChatInjector](https://www.spigotmc.org/resources/38327) in order for the placeholders to show up in the chat. However, please note it has been reported that ChatInjector might cause issues. ## PlotSquared placeholders {% hint style="info" %} If you think a placeholder for PlotSquared should be added, then please [raise an issue here](https://github.com/IntellectualSites/PlotSquared/issues/new/choose). {% endhint %} *Available placeholders in 6.0.0 onwards:* | Placeholder | Description | | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `%plotsquared_currentplot_alias%` | Alias of the plot | | `%plotsquared_currentplot_owner%` | Owner of the plot | | `%plotsquared_currentplot_owners%` | Owners of the plot (useful if multi-owner are used) | | `%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_added_list%` | Display a list of added members | | `%plotsquared_currentplot_members_trusted%` | Amount of players trusted to the plot | | `%plotsquared_currentplot_members_trusted_list%` | Display a list of trusted members | | `%plotsquared_currentplot_members_denied%` | Amount of members denied from the plot | | `%plotsquared_currentplot_members_denied_list%` | Display a list of denied members | | `%plotsquared_currentplot_can_build%` | Displays `true` or `false` whether the player has build rights on 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 or 'this')%` | Displays `true` or `false` whether the player has plot in a specific world | | `%plotsquared_plot_count%` | Amount of global plots of a player | | `%plotsquared_plot_count_(world or 'this')%` | Amount of plots for a player in a specific world | | `%plotsquared_base_plot_count%` | Amount of global plots of a player, counting merged plots as one | | `%plotsquared_base_plot_count_(world or 'this')%` | Amount of plots for a player in a specific world, counting merged plots as one | | `%plotsquared_allowed_plot_count%` | Amount of maximum plots a player can have (returns "infinite" if you have `plots.admin` or `plots.plot.*` permission) | | `%plotsquared_currentplot_xy%` | Displays the X and Y ID of a plot (from the base plot if merged) | | `%plotsquared_currentplot_x%` | Displays the X ID of a plot (from the base plot if merged) | | `%plotsquared_currentplot_y%` | Displays the Y ID of a plot (from the base plot if merged) | | `%plotsquared_currentplot_abs_xy%` | Displays the X and Y ID of a plot (absolute = not base plot if merged) | | `%plotsquared_currentplot_abs_x%` | Displays the X ID of a plot (absolute = not base plot if merged) | | `%plotsquared_currentplot_abs_y%` | Displays the Y ID of a plot (absolute = not base plot if merged) | | `%plotsquared_currentplot_rating%` | Displays the average rating of a plot | | `%plotsquared_currentplot_biome%` | Displays the biome of a plot | | `%plotsquared_currentplot_size%` | Displays the size of a merged plot | | `%plotsquared_currentplot_creationdate%` | Display the creation date of the plot | | `%plotsquared_total_grants%` | Display the total amount of plot grants | | `%server_plot_count%` | Amount of all plots on the entire server | | `%server_plot_count_(world or 'this')%` | Amount of all plots on the entire server in the specified world | | `%server_base_plot_count%` | Amount of all plots on the entire server, counting merged plots as one | | `%server_base_plot_count_(world or 'this')%` | Amount of all plots on the entire server in the specified world, counting merged plots as one | ## External placeholders * [PlaceholderAPI placeholders](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders) * [MVdWPlaceholderAPI placeholders](https://www.spigotmc.org/wiki/mvdw-placeholders) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://intellectualsites.gitbook.io/plotsquared/customization/placeholders.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.