Merge branch 'PlaceholderAPI:wiki' into wiki
46
FAQ.md
@ -2,29 +2,35 @@
|
|||||||
|
|
||||||
Here are frequently asked questions about stuff related to PlaceholderAPI.
|
Here are frequently asked questions about stuff related to PlaceholderAPI.
|
||||||
|
|
||||||
|
## What is an Expansion?
|
||||||
|
An expansion (aka PlaceholderExpansion) usualy refers to a separate jar file that is added to PlaceholderAPI's `expansion` folder to add extra placeholders to use in other plugins.
|
||||||
|
External PlaceholderExpansions are downloaded from PlaceholderAPI's eCloud through the [[`/papi ecloud download <expansion>`|Commands#papi-ecloud-download]] command.
|
||||||
|
|
||||||
|
Some plugins may provide their PlaceholderExpansion directly without any external jar file being used.
|
||||||
|
|
||||||
## It only shows `%placeholder%` and not the variable
|
## It only shows `%placeholder%` and not the variable
|
||||||
When a plugin or `/papi parse me %placeholder%` only returns the placeholder itself and no value should you check for the following things:
|
When a plugin or `/papi parse me %placeholder%` only returns the placeholder itself and no value should you check for the following things:
|
||||||
|
|
||||||
### The expansion is actually installed.
|
- ### The expansion is actually installed.
|
||||||
In many cases is the cause that the expansion of the placeholder is missing.
|
In many cases is the cause that the expansion of the placeholder is missing.
|
||||||
Just execute `/papi ecloud download <name of expansion>` followed by `/papi reload` to activate it. You can find a list of Expansions and their Placeholders [[on this page|Placeholders]].
|
Just execute `/papi ecloud download <name of expansion>` followed by `/papi reload` to activate it. You can find a list of Expansions and their Placeholders [[on this page|Placeholders]].
|
||||||
|
|
||||||
**NOTE!**
|
**NOTE!**
|
||||||
Not all placeholders come in their own expansion. Some plugins *hardcode* them in and load them on startup, when hooking into PlaceholderAPI.
|
Not all placeholders come in their own expansion. Some plugins *hardcode* them in and load them on startup, when hooking into PlaceholderAPI.
|
||||||
|
|
||||||
### Plugin actualls supports PlaceholderAPI
|
- ### Plugin actually supports PlaceholderAPI
|
||||||
It can happen that the plugin you use to display the placeholder in doesn't support PlaceholderAPI. In such a case check, if the parse command returns the actual value of a placeholder.
|
It can happen that the plugin you use to display the placeholder in doesn't support PlaceholderAPI. In such a case check, if the parse command returns the actual value of a placeholder.
|
||||||
If that is the case while the plugin is still displaying the placeholder, can this be an indicator of the plugin not supporting PlaceholderAPI.
|
If that is the case while the plugin is still displaying the placeholder, can this be an indicator of the plugin not supporting PlaceholderAPI.
|
||||||
|
|
||||||
You can find a list of plugins supporting PlaceholderAPI [[here|Plugins-using-PlaceholderAPI]].
|
You can find a list of plugins supporting PlaceholderAPI [[here|Plugins-using-PlaceholderAPI]].
|
||||||
Just make sure that "Supports placeholders" has a check mark in front of it.
|
Just make sure that "Supports placeholders" has a check mark in front of it.
|
||||||
|
|
||||||
### No typo in the placeholder
|
- ### No typo in the placeholder
|
||||||
Double-check that the placeholder you set doesn't contain a typo. You can use `/papi ecloud placeholders <expansion>` (replace `<expansion>` with the name of the expansion) to get a list of all the placeholders the expansion may have.
|
Double-check that the placeholder you set doesn't contain a typo. You can use `/papi ecloud placeholders <expansion>` (replace `<expansion>` with the name of the expansion) to get a list of all the placeholders the expansion may have.
|
||||||
Keep in mind that this only works for separate expansions on the eCloud and not for those that are loaded by plugins.
|
Keep in mind that this only works for separate expansions on the eCloud and not for those that are loaded by plugins.
|
||||||
|
|
||||||
### Plugin is enabled
|
- ### Plugin is enabled
|
||||||
If an expansion depends on a plugin, make sure you have the plugin installed and that it is enabled (Shows green in `/pl`).
|
If an expansion depends on a plugin, make sure you have the plugin installed and that it is enabled (Shows green in `/pl`).
|
||||||
|
|
||||||
## I can't download the expansion
|
## I can't download the expansion
|
||||||
Make sure, that the connection to the cloud (https://api.extendedclip.com) isn't blocked by a firewall or similar.
|
Make sure, that the connection to the cloud (https://api.extendedclip.com) isn't blocked by a firewall or similar.
|
||||||
|
1
Home.md
@ -5,6 +5,7 @@ This wiki gives you information on how to create placeholders in your plugin tha
|
|||||||
It also has a list with all available placeholders (Work in progress).
|
It also has a list with all available placeholders (Work in progress).
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
**[[Using Placeholders]]**
|
||||||
**[[Hook into PlaceholderAPI]]**
|
**[[Hook into PlaceholderAPI]]**
|
||||||
- [[First steps|Hook-into-PlaceholderAPI#first-steps]]
|
- [[First steps|Hook-into-PlaceholderAPI#first-steps]]
|
||||||
- [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]]
|
- [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]]
|
||||||
|
269
Placeholders.md
@ -190,6 +190,7 @@ If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, th
|
|||||||
- **[DeluxePM](#deluxepm)**
|
- **[DeluxePM](#deluxepm)**
|
||||||
- **[DeluxeTags](#deluxetags)**
|
- **[DeluxeTags](#deluxetags)**
|
||||||
- **[Denizen](#denizen)**
|
- **[Denizen](#denizen)**
|
||||||
|
- **[DimensionPlaceholders](#dimensionplaceholders)**
|
||||||
- **[DiscordSRV](#discordsrv)**
|
- **[DiscordSRV](#discordsrv)**
|
||||||
- **[Disease](#disease)**
|
- **[Disease](#disease)**
|
||||||
- **[DonateParty](#donateparty)**
|
- **[DonateParty](#donateparty)**
|
||||||
@ -231,6 +232,7 @@ If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, th
|
|||||||
- **[HoloMobHealth](#holomobhealth)**
|
- **[HoloMobHealth](#holomobhealth)**
|
||||||
- **[HPWizard](#hpwizard)**
|
- **[HPWizard](#hpwizard)**
|
||||||
- **[Hugs](#hugs)**
|
- **[Hugs](#hugs)**
|
||||||
|
- **[HyacinthHello](#hyacinthhello)**
|
||||||
|
|
||||||
- ### **I**
|
- ### **I**
|
||||||
- **[InteractionVisualizer](#interactionvisualizer)**
|
- **[InteractionVisualizer](#interactionvisualizer)**
|
||||||
@ -257,6 +259,7 @@ If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, th
|
|||||||
- **[LemonMobCoins](#lemonmobcoins)**
|
- **[LemonMobCoins](#lemonmobcoins)**
|
||||||
- **[LevelledMobs](#levelledmobs)**
|
- **[LevelledMobs](#levelledmobs)**
|
||||||
- **[LevelUp](#levelup)**
|
- **[LevelUp](#levelup)**
|
||||||
|
- **[LotterySix](#lotterysix)**
|
||||||
- **[LuckPerms](#luckperms)**
|
- **[LuckPerms](#luckperms)**
|
||||||
- **[LWC](#lwc)**
|
- **[LWC](#lwc)**
|
||||||
|
|
||||||
@ -313,6 +316,7 @@ If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, th
|
|||||||
- **[PointsAPI](#pointsapi)**
|
- **[PointsAPI](#pointsapi)**
|
||||||
- **[PowerBoard](#powerboard)**
|
- **[PowerBoard](#powerboard)**
|
||||||
- **[PowerRanks](#powerranks)**
|
- **[PowerRanks](#powerranks)**
|
||||||
|
- **[PrefiX](#prefix)**
|
||||||
- **[PremiumVanish](#premiumvanish)**
|
- **[PremiumVanish](#premiumvanish)**
|
||||||
- **[Prison](#prison)**
|
- **[Prison](#prison)**
|
||||||
- **[PrisonMines](#prisonmines)**
|
- **[PrisonMines](#prisonmines)**
|
||||||
@ -419,6 +423,7 @@ If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, th
|
|||||||
- **[VotingPlugin](#votingplugin)**
|
- **[VotingPlugin](#votingplugin)**
|
||||||
|
|
||||||
- ### **W**
|
- ### **W**
|
||||||
|
- **[Weight-RPG](#weightrpg)**
|
||||||
- **[WickedSkyWars](#wickedskywars)**
|
- **[WickedSkyWars](#wickedskywars)**
|
||||||
- **[WorldBorder](#worldborder)**
|
- **[WorldBorder](#worldborder)**
|
||||||
- **[WorldGuard](#worldguard)**
|
- **[WorldGuard](#worldguard)**
|
||||||
@ -647,8 +652,8 @@ A majority of these Expansions are maintained by the PlaceholderAPI team and can
|
|||||||
Requires `mat:` modifier. Strictly checks the name and lore for an item. (If a Stone named `Test` is in your inventory, and you're using `%checkitem_mat:stone,strict%`, it will return false)
|
Requires `mat:` modifier. Strictly checks the name and lore for an item. (If a Stone named `Test` is in your inventory, and you're using `%checkitem_mat:stone,strict%`, it will return false)
|
||||||
- `inhand`
|
- `inhand`
|
||||||
Check if the item is in the player's hand. `inhand` will check *both* hands. You can add `:main` or `:off` to specify. (Ex: `inhand:main`)
|
Check if the item is in the player's hand. `inhand` will check *both* hands. You can add `:main` or `:off` to specify. (Ex: `inhand:main`)
|
||||||
- `inslot`
|
- `inslot:<number>`
|
||||||
Check if the item is in a specific slot ([Click here for valid slots](https://proxy.spigotmc.org/d3e11b631e22f45fc07c3fcd1c7000b2245fed78?url=http%3A%2F%2Fi.imgur.com%2F3YCrfC8.png))
|
Check if the item is in a specific slot ([Click here for valid slots](https://i.imgur.com/3YCrfC8.png))
|
||||||
- `nbtstrings:<key>=<value>;<key>=<value>`
|
- `nbtstrings:<key>=<value>;<key>=<value>`
|
||||||
Checks if the item's nbtStrings contains `<key>` with the value of `<value>`. * ^ ~
|
Checks if the item's nbtStrings contains `<key>` with the value of `<value>`. * ^ ~
|
||||||
- `nbtints:<key>=<value>;<key>=<value>`
|
- `nbtints:<key>=<value>;<key>=<value>`
|
||||||
@ -691,28 +696,33 @@ A majority of these Expansions are maintained by the PlaceholderAPI team and can
|
|||||||
- ### **Formatter**
|
- ### **Formatter**
|
||||||
> /papi ecloud download Formatter
|
> /papi ecloud download Formatter
|
||||||
|
|
||||||
More info about this expansion can be found on the [GitHub-Repository](https://github.com/Andre601/Formatter-Expansion).
|
More info about this expansion can be found on the [Codeberg-Repository](https://codeberg.org/Andre601/Formatter-Expansion).
|
||||||
|
|
||||||
`[]` is optional and `<>` is required.
|
`[]` is optional and `<>` is required.
|
||||||
|
|
||||||
```
|
```
|
||||||
%formatter_number_format_<number>%
|
%formatter_number_format_<number>%
|
||||||
%formatter_number_format_[locale]:[format]_<number>%
|
%formatter_number_format_[locale]:[pattern]_<number>%
|
||||||
|
|
||||||
%formatter_number_from:<timeunit>_to:<timeunit>_<number>% # Converts <number> from one time unit to another
|
%formatter_number_from:<timeunit>_to:<timeunit>_<number>% # Converts <number> from one time unit to another
|
||||||
|
|
||||||
%formatter_number_time_<number>%
|
%formatter_number_round_<number>%
|
||||||
%formatter_number_time_fromSeconds_<number>% # Handles number as seconds
|
%formatter_number_[precision]:[roundingmode]_<number>%
|
||||||
%formatter_number_time_fromSecs_<number>% # Handles number as seconds
|
|
||||||
%formatter_number_time_fromMinutes_<number>% # Handles number as minutes
|
%formatter_number_shorten_<number>%
|
||||||
%formatter_number_time_fromMins_<number>% # Handles number as minutes
|
|
||||||
%formatter_number_time_fromHours_<number>% # Handles number as hours
|
%formatter_number_time_<number>%
|
||||||
%formatter_number_time_fromHrs_<number>% # Handles number as hours
|
%formatter_number_time_<timeunit>_<number>% # Handles number as <timeunit>
|
||||||
|
|
||||||
|
%formatter_text_length_<text>%
|
||||||
|
|
||||||
%formatter_text_replace_<target>_<replacement>_<text>%
|
|
||||||
%formatter_text_substring_[start]:[end]_<text>%
|
|
||||||
%formatter_text_uppercase_<text>%
|
|
||||||
%formatter_text_lowercase_<text>%
|
%formatter_text_lowercase_<text>%
|
||||||
|
|
||||||
|
%formatter_text_replace_[target]_[replacement]_<text>%
|
||||||
|
|
||||||
|
%formatter_text_substring_[start]:[end]_<text>%
|
||||||
|
|
||||||
|
%formatter_text_uppercase_<text>%
|
||||||
```
|
```
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -961,9 +971,11 @@ A majority of these Expansions are maintained by the PlaceholderAPI team and can
|
|||||||
%player_has_empty_slot%
|
%player_has_empty_slot%
|
||||||
%player_has_played_before%
|
%player_has_played_before%
|
||||||
%player_empty_slots%
|
%player_empty_slots%
|
||||||
|
%player_has_health_boost%
|
||||||
%player_has_potioneffect_<effect>%
|
%player_has_potioneffect_<effect>%
|
||||||
%player_has_permission_<permission>%
|
%player_has_permission_<permission>%
|
||||||
%player_health%
|
%player_health%
|
||||||
|
%player_health_boost%
|
||||||
%player_health_rounded%
|
%player_health_rounded%
|
||||||
%player_health_scale%
|
%player_health_scale%
|
||||||
%player_ip%
|
%player_ip%
|
||||||
@ -1257,13 +1269,13 @@ A majority of these Expansions are maintained by the PlaceholderAPI team and can
|
|||||||
- ### **Shortcut**
|
- ### **Shortcut**
|
||||||
> /papi ecloud download Shortcut
|
> /papi ecloud download Shortcut
|
||||||
|
|
||||||
Allows the parsing of large text with placeholders by having them in TXT files stored.
|
Allows to parse large amounts of text, including placeholders from PlaceholderAPI.
|
||||||
|
Please visit the [GitHub Repository](https://github.com/Andre601/Shortcut-Expansion) for details and usage.
|
||||||
|
|
||||||
```
|
```
|
||||||
%shortcut_<filename without .txt>%
|
%shortcut_<filename>%
|
||||||
|
%shortcut_<filename>:<replacement1>:replacement2>:...%
|
||||||
```
|
```
|
||||||
|
|
||||||
The file needs to be a TXT and has to be inside `plugins/PlaceholderAPI/shortcuts`.
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
@ -2508,6 +2520,22 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
- ### **[DimensionPlaceholders](https://www.spigotmc.org/resources/107769/)**
|
||||||
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
|
Placeholders information can be found on [Github](https://github.com/BoBkiNN/DimensionPlaceholders)
|
||||||
|
|
||||||
|
```
|
||||||
|
%dimplc_color%
|
||||||
|
%dimplc_folder%
|
||||||
|
%dimplc_namespacedkey%
|
||||||
|
%dimplc_namespace%
|
||||||
|
%dimplc_key%
|
||||||
|
%dimplc_loadedchunks%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
- ### **[DiscordSRV](https://www.spigotmc.org/resources/18494/)**
|
- ### **[DiscordSRV](https://www.spigotmc.org/resources/18494/)**
|
||||||
> NO DOWNLOAD COMMAND
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
@ -2670,10 +2698,11 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
%essentials_afk%
|
%essentials_afk%
|
||||||
%essentials_afk_reason%
|
%essentials_afk_reason%
|
||||||
%essentials_fly%
|
%essentials_fly%
|
||||||
|
%essentials_geolocation%
|
||||||
%essentials_godmode%
|
%essentials_godmode%
|
||||||
%essentials_has_kit_<kitname>%
|
%essentials_has_kit_<kitname>%
|
||||||
%essentials_home_<number>
|
%essentials_home_<number>
|
||||||
%essentials_home_<number>_<x|y|z>%
|
%essentials_home_<number>_<w|x|y|z>%
|
||||||
%essentials_homes_set%
|
%essentials_homes_set%
|
||||||
%essentials_homes_max%
|
%essentials_homes_max%
|
||||||
%essentials_is_muted%
|
%essentials_is_muted%
|
||||||
@ -2687,6 +2716,7 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
%essentials_kit_time_until_available_<kitname>%
|
%essentials_kit_time_until_available_<kitname>%
|
||||||
%essentials_kit_time_until_available_raw_<kitname>%
|
%essentials_kit_time_until_available_raw_<kitname>%
|
||||||
%essentials_msg_ignore%
|
%essentials_msg_ignore%
|
||||||
|
%essentials_muted_time_remaining%
|
||||||
%essentials_nickname%
|
%essentials_nickname%
|
||||||
%essentials_nickname_stripped%
|
%essentials_nickname_stripped%
|
||||||
%essentials_pm_recipient%
|
%essentials_pm_recipient%
|
||||||
@ -3044,6 +3074,13 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
%hugs_player_total_given%
|
%hugs_player_total_given%
|
||||||
%hugs_player_total_received%
|
%hugs_player_total_received%
|
||||||
```
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
- ### **[HyacinthHello](https://www.spigotmc.org/resources/104434/)**
|
||||||
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
|
You can find an up-to-date list of placeholders in the [HyacinthHello wiki](https://github.com/livelaughlemon/hyacinthhello/wiki#placeholders).
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
@ -3390,6 +3427,99 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
- ### **[LotterySix](https://www.spigotmc.org/resources/107573/)**
|
||||||
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
|
```
|
||||||
|
%lotterysix_currentgame_Now%
|
||||||
|
%lotterysix_currentgame_GameNumber%
|
||||||
|
%lotterysix_currentgame_GameNumberRaw%
|
||||||
|
%lotterysix_currentgame_SpecialName%
|
||||||
|
%lotterysix_currentgame_Date%
|
||||||
|
%lotterysix_currentgame_NumberOfChoices%
|
||||||
|
%lotterysix_currentgame_PricePerBet%
|
||||||
|
%lotterysix_currentgame_TotalBets%
|
||||||
|
%lotterysix_currentgame_PrizePool%
|
||||||
|
%lotterysix_currentgame_FIRSTOdds%
|
||||||
|
%lotterysix_currentgame_SECONDOdds%
|
||||||
|
%lotterysix_currentgame_THIRDOdds%
|
||||||
|
%lotterysix_currentgame_FOURTHOdds%
|
||||||
|
%lotterysix_currentgame_FIFTHOdds%
|
||||||
|
%lotterysix_currentgame_SIXTHOdds%
|
||||||
|
%lotterysix_currentgame_SEVENTHOdds%
|
||||||
|
%lotterysix_currentgame_BetPlayerNames%
|
||||||
|
%lotterysix_currentgame_<number>LastDrawn%
|
||||||
|
%lotterysix_currentgame_<number>TimesDrawn%
|
||||||
|
%lotterysix_lastgame_Now%
|
||||||
|
%lotterysix_lastgame_GameNumber%
|
||||||
|
%lotterysix_lastgame_GameNumberRaw%
|
||||||
|
%lotterysix_lastgame_SpecialName%
|
||||||
|
%lotterysix_lastgame_Date%
|
||||||
|
%lotterysix_lastgame_NumberOfChoices%
|
||||||
|
%lotterysix_lastgame_PricePerBet%
|
||||||
|
%lotterysix_lastgame_TotalBets%
|
||||||
|
%lotterysix_lastgame_TotalPrizes%
|
||||||
|
%lotterysix_lastgame_FirstToThirdPlaceWinnersCount%
|
||||||
|
%lotterysix_lastgame_FirstNumber%
|
||||||
|
%lotterysix_lastgame_SecondNumber%
|
||||||
|
%lotterysix_lastgame_ThirdNumber%
|
||||||
|
%lotterysix_lastgame_FourthNumber%
|
||||||
|
%lotterysix_lastgame_FifthNumber%
|
||||||
|
%lotterysix_lastgame_SixthNumber%
|
||||||
|
%lotterysix_lastgame_FirstNumberOrdered%
|
||||||
|
%lotterysix_lastgame_SecondNumberOrdered%
|
||||||
|
%lotterysix_lastgame_ThirdNumberOrdered%
|
||||||
|
%lotterysix_lastgame_FourthNumberOrdered%
|
||||||
|
%lotterysix_lastgame_FifthNumberOrdered%
|
||||||
|
%lotterysix_lastgame_SixthNumberOrdered%
|
||||||
|
%lotterysix_lastgame_SpecialNumber%
|
||||||
|
%lotterysix_lastgame_BetPlayerNames%
|
||||||
|
%lotterysix_lastgame_FIRSTPlayerNames%
|
||||||
|
%lotterysix_lastgame_SECONDPlayerNames%
|
||||||
|
%lotterysix_lastgame_THIRDPlayerNames%
|
||||||
|
%lotterysix_lastgame_FOURTHPlayerNames%
|
||||||
|
%lotterysix_lastgame_FIFTHPlayerNames%
|
||||||
|
%lotterysix_lastgame_SIXTHPlayerNames%
|
||||||
|
%lotterysix_lastgame_SEVENTHPlayerNames%
|
||||||
|
%lotterysix_lastgame_FIRSTOdds%
|
||||||
|
%lotterysix_lastgame_SECONDOdds%
|
||||||
|
%lotterysix_lastgame_THIRDOdds%
|
||||||
|
%lotterysix_lastgame_FOURTHOdds%
|
||||||
|
%lotterysix_lastgame_FIFTHOdds%
|
||||||
|
%lotterysix_lastgame_SIXTHOdds%
|
||||||
|
%lotterysix_lastgame_SEVENTHOdds%
|
||||||
|
%lotterysix_lastgame_FIRSTPrize%
|
||||||
|
%lotterysix_lastgame_SECONDPrize%
|
||||||
|
%lotterysix_lastgame_THIRDPrize%
|
||||||
|
%lotterysix_lastgame_FOURTHPrize%
|
||||||
|
%lotterysix_lastgame_FIFTHPrize%
|
||||||
|
%lotterysix_lastgame_SIXTHPrize%
|
||||||
|
%lotterysix_lastgame_SEVENTHPrize%
|
||||||
|
%lotterysix_lastgame_FIRSTPrizeCount%
|
||||||
|
%lotterysix_lastgame_SECONDPrizeCount%
|
||||||
|
%lotterysix_lastgame_THIRDPrizeCount%
|
||||||
|
%lotterysix_lastgame_FOURTHPrizeCount%
|
||||||
|
%lotterysix_lastgame_FIFTHPrizeCount%
|
||||||
|
%lotterysix_lastgame_SIXTHPrizeCount%
|
||||||
|
%lotterysix_lastgame_SEVENTHPrizeCount%
|
||||||
|
%lotterysix_lastgame_<number>LastDrawn%
|
||||||
|
%lotterysix_lastgame_<number>TimesDrawn%
|
||||||
|
%lotterysix_preference_hide_titles%
|
||||||
|
%lotterysix_preference_hide_periodic_announcements%
|
||||||
|
%lotterysix_preference_bet_limit_per_round%
|
||||||
|
%lotterysix_preference_reopen_menu_on_purchase%
|
||||||
|
%lotterysix_preference_suspend_account_until%
|
||||||
|
%lotterysix_stats_total_bets_placed%
|
||||||
|
%lotterysix_stats_total_rounds_participated%
|
||||||
|
%lotterysix_stats_total_winnings%
|
||||||
|
%lotterysix_stats_highest_won_tier%
|
||||||
|
%lotterysix_stats_pending_transaction%
|
||||||
|
%lotterysix_scheduler_interval%
|
||||||
|
%lotterysix_scheduler_next%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
- ### **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
|
- ### **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
|
||||||
> /papi ecloud download LuckPerms
|
> /papi ecloud download LuckPerms
|
||||||
|
|
||||||
@ -3965,18 +4095,24 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
> NO DOWNLOAD COMMAND
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
```
|
```
|
||||||
%parkour_maker_player_name%
|
%parkourmaker_player_name%
|
||||||
%parkour_maker_parkour_name%
|
%parkourmaker_parkour_name%
|
||||||
%parkour_maker_current_checkpoint%
|
%parkourmaker_current_checkpoint%
|
||||||
%parkour_maker_current_checkpoint_position%
|
%parkourmaker_current_checkpoint_position%
|
||||||
%parkour_maker_join_cooldown%
|
%parkourmaker_join_cooldown%
|
||||||
%parkour_maker_reward_cooldown%
|
%parkourmaker_reward_cooldown%
|
||||||
%parkour_maker_start_message%
|
%parkourmaker_start_message%
|
||||||
%parkour_maker_finish_message%
|
%parkourmaker_finish_message%
|
||||||
%parkour_maker_map_join_cooldown%
|
%parkourmaker_map_join_cooldown%
|
||||||
%parkour_maker_map_reward_cooldown%
|
%parkourmaker_map_reward_cooldown%
|
||||||
|
%parkourmaker_best-time_<map_name>.<player_name>%
|
||||||
|
%parkourmaker_leaderboard_<map_name>.<position>%
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Replace `<map_name>` with name of the map you wish to get time for.<br>
|
||||||
|
Replace `<player_name>` with name of the player you wish to display time for.<br>
|
||||||
|
Replace `<position>` with number that coresponds to the position you want to display.
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
- ### **[ParkPlusMC](https://polymart.org/resource/parkplusmc.2317)**
|
- ### **[ParkPlusMC](https://polymart.org/resource/parkplusmc.2317)**
|
||||||
@ -4111,7 +4247,23 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
|
|
||||||
```
|
```
|
||||||
%ptr_playtime%
|
%ptr_playtime%
|
||||||
|
%ptr_playtime_days%
|
||||||
|
%ptr_playtime_days_trimmed%
|
||||||
|
%ptr_playtime_hours%
|
||||||
|
%ptr_playtime_hours_trimmed%
|
||||||
|
%ptr_playtime_minutes%
|
||||||
|
%ptr_playtime_minutes_trimmed%
|
||||||
|
%ptr_playtime_seconds%
|
||||||
|
%ptr_playtime_seconds_trimmed%
|
||||||
%ptr_sessiontime%
|
%ptr_sessiontime%
|
||||||
|
%ptr_sessiontime_days%
|
||||||
|
%ptr_sessiontime_days_trimmed%
|
||||||
|
%ptr_sessiontime_hours%
|
||||||
|
%ptr_sessiontime_hours_trimmed%
|
||||||
|
%ptr_sessiontime_minutes%
|
||||||
|
%ptr_sessiontime_minutes_trimmed%
|
||||||
|
%ptr_sessiontime_seconds%
|
||||||
|
%ptr_sessiontime_seconds_trimmed%
|
||||||
```
|
```
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -4200,6 +4352,29 @@ Please see [this discussion][list] for a list of all expansions officially maint
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
- ### **[PrefiX](https://www.spigotmc.org/resources/70359/)**
|
||||||
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
|
```
|
||||||
|
%prefix_prefix%
|
||||||
|
%prefix_startcolor%
|
||||||
|
%prefix_startchar%
|
||||||
|
%prefix_tagcolor%
|
||||||
|
%prefix_tag%
|
||||||
|
%prefix_endchar%
|
||||||
|
%prefix_namecolor%
|
||||||
|
|
||||||
|
%suffix_suffix%
|
||||||
|
%suffix_startcolor%
|
||||||
|
%suffix_startchar%
|
||||||
|
%suffix_tagcolor%
|
||||||
|
%suffix_tag%
|
||||||
|
%suffix_endchar%
|
||||||
|
%suffix_namecolor%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
- ### **[PremiumVanish](https://www.spigotmc.org/resources/14404/)**
|
- ### **[PremiumVanish](https://www.spigotmc.org/resources/14404/)**
|
||||||
> NO DOWNLOAD COMMAND
|
> NO DOWNLOAD COMMAND
|
||||||
|
|
||||||
@ -6006,32 +6181,20 @@ All placeholders are listed here: https://wiki.staffplusplus.org/integrations/pa
|
|||||||
%vault_eco_balance_fixed%
|
%vault_eco_balance_fixed%
|
||||||
%vault_eco_balance_formatted%
|
%vault_eco_balance_formatted%
|
||||||
%vault_eco_balance_commas%
|
%vault_eco_balance_commas%
|
||||||
%vault_eco_commas%
|
|
||||||
%vault_eco_fixed%
|
|
||||||
%vault_eco_formatted%
|
|
||||||
|
|
||||||
# Permission/Group placeholders
|
# Permission/Group placeholders
|
||||||
%vault_group%
|
%vault_group%
|
||||||
%vault_group_capital%
|
%vault_group_capital%
|
||||||
|
%vault_groups%
|
||||||
|
%vault_groups_capital%
|
||||||
|
%vault_prefix%
|
||||||
|
%vault_suffix%
|
||||||
%vault_groupprefix%
|
%vault_groupprefix%
|
||||||
%vault_groupprefix_<position>%
|
%vault_groupprefix_<position>%
|
||||||
%vault_groups%
|
|
||||||
%vault_groupsuffix%
|
%vault_groupsuffix%
|
||||||
%vault_groupsuffix_<position>%
|
%vault_groupsuffix_<position>%
|
||||||
%vault_hasgroup_<group>%
|
%vault_hasgroup_<group>%
|
||||||
%vault_inprimarygroup_<group>%
|
%vault_inprimarygroup_<group>%
|
||||||
%vault_prefix%
|
|
||||||
%vault_prefix_color%
|
|
||||||
%vault_rank%
|
|
||||||
%vault_rank_capital%
|
|
||||||
%vault_rankprefix%
|
|
||||||
%vault_rankprefix_<position>%
|
|
||||||
%vault_ranks%
|
|
||||||
%vault_ranksuffix_<position>%
|
|
||||||
%vault_suffix%
|
|
||||||
%vault_suffix_color%
|
|
||||||
%vault_user_prefix_color%
|
|
||||||
%vault_user_suffix_color%
|
|
||||||
```
|
```
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -6143,6 +6306,20 @@ All placeholders are listed here: https://wiki.staffplusplus.org/integrations/pa
|
|||||||
%VotingPlugin_VotePartyVotesRequired%
|
%VotingPlugin_VotePartyVotesRequired%
|
||||||
```
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
- ### **[Weight-RPG](https://www.spigotmc.org/resources/105513/)**
|
||||||
|
> NO DOWNLOAD COMMAND
|
||||||
|
```
|
||||||
|
%weight-rpg_current_weight%
|
||||||
|
%weight-rpg_max_weight%
|
||||||
|
%weight-rpg_armor_weight%
|
||||||
|
%weight-rpg_item_in_main_hand%
|
||||||
|
%weight-rpg_item_in_second_hand%
|
||||||
|
%weight-rpg_weight_level1%
|
||||||
|
%weight-rpg_weight_level2%
|
||||||
|
%weight-rpg_weight_level3%
|
||||||
|
```
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
- ### **[WickedSkyWars](https://www.spigotmc.org/resources/556/)**
|
- ### **[WickedSkyWars](https://www.spigotmc.org/resources/556/)**
|
||||||
|
@ -485,6 +485,9 @@ If your plugin isn't shown here and you want it to be added, [read the Wiki READ
|
|||||||
- **[LevelledMobs](https://www.spigotmc.org/resources/levelledmobs-for-1-14-x-1-17-x.74304/)**
|
- **[LevelledMobs](https://www.spigotmc.org/resources/levelledmobs-for-1-14-x-1-17-x.74304/)**
|
||||||
- [ ] Supports placeholders.
|
- [ ] Supports placeholders.
|
||||||
- [x] Provides own placeholders. [**[[Link|Placeholders#levelledmobs]]**]
|
- [x] Provides own placeholders. [**[[Link|Placeholders#levelledmobs]]**]
|
||||||
|
- **[LotterySix](https://www.spigotmc.org/resources/107573/)**
|
||||||
|
- [x] Supports placeholders.
|
||||||
|
- [x] Provides own placeholders. [**[[Link|Placeholders#lotterysix]]**]
|
||||||
- **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
|
- **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
|
||||||
- [ ] Supports placeholders.
|
- [ ] Supports placeholders.
|
||||||
- [x] Provides own placeholders. [**[[Link|Placeholders#luckperms]]**]
|
- [x] Provides own placeholders. [**[[Link|Placeholders#luckperms]]**]
|
||||||
@ -665,6 +668,9 @@ If your plugin isn't shown here and you want it to be added, [read the Wiki READ
|
|||||||
- **[PowerRanks](https://www.spigotmc.org/resources/64696/)**
|
- **[PowerRanks](https://www.spigotmc.org/resources/64696/)**
|
||||||
- [x] Supports placeholders.
|
- [x] Supports placeholders.
|
||||||
- [x] Provides own placeholders. [**[[Link|Placeholders#powerranks]]**]
|
- [x] Provides own placeholders. [**[[Link|Placeholders#powerranks]]**]
|
||||||
|
- **[PrefiX](https://www.spigotmc.org/resources/70359/)**
|
||||||
|
- [ ] Supports placeholders.
|
||||||
|
- [x] Provides own placeholders. [**[[Link|Placeholders#prefix]]**]
|
||||||
- **[PremiumVanish](https://www.spigotmc.org/resources/14404/)**
|
- **[PremiumVanish](https://www.spigotmc.org/resources/14404/)**
|
||||||
- [ ] Supports placeholders.
|
- [ ] Supports placeholders.
|
||||||
- [x] Provides own placeholders. [**[[Link|Placeholders#premiumvanish]]**]
|
- [x] Provides own placeholders. [**[[Link|Placeholders#premiumvanish]]**]
|
||||||
|
21
README.md
@ -6,6 +6,8 @@
|
|||||||
[discord]: https://discord.gg/HelpChat
|
[discord]: https://discord.gg/HelpChat
|
||||||
[discussion]: https://github.com/PlaceholderAPI/PlaceholderAPI/discussions
|
[discussion]: https://github.com/PlaceholderAPI/PlaceholderAPI/discussions
|
||||||
|
|
||||||
|
[expansion-generator]: https://www.andre601.ch/Expansion-Wiki-Generator/
|
||||||
|
|
||||||
[andre]: https://github.com/Andre601
|
[andre]: https://github.com/Andre601
|
||||||
[andrew]: https://github.com/Andrew-Chen-Wang
|
[andrew]: https://github.com/Andrew-Chen-Wang
|
||||||
[action]: https://github.com/Andrew-Chen-Wang/github-wiki-action
|
[action]: https://github.com/Andrew-Chen-Wang/github-wiki-action
|
||||||
@ -25,7 +27,8 @@ If you want to contribute towards the wiki, will you need to follow the below in
|
|||||||
> Already having a fork? Skip to the [next Step](#select-target-branch)!
|
> Already having a fork? Skip to the [next Step](#select-target-branch)!
|
||||||
|
|
||||||
You need to make a fork of the PlaceholderAPI Repository to contribute towards the wiki.
|
You need to make a fork of the PlaceholderAPI Repository to contribute towards the wiki.
|
||||||
To fork the repository, click the button on the top-right that says "Fork". In the new page, select the account/organisation you want to fork this repository towards and click "Create fork".
|
To fork the repository, click the button on the top-right that says "Fork". In the new page, select the account/organisation you want to fork this repository towards and make sure to have "Copy the `master` branch only" unchecked, so that the `wiki` branch is copied too.
|
||||||
|
After this, click "Create fork".
|
||||||
|
|
||||||
![fork repo](./img/readme/fork.png)
|
![fork repo](./img/readme/fork.png)
|
||||||
|
|
||||||
@ -40,14 +43,14 @@ Before you try to make any changes should you make sure that you have the `wiki`
|
|||||||
### Fetch Changes from Upstream
|
### Fetch Changes from Upstream
|
||||||
This is only required when you already had a fork and didn't update it for some time.
|
This is only required when you already had a fork and didn't update it for some time.
|
||||||
|
|
||||||
While you're on the `wiki` branch, click the `Fetch upstream` text located right below the green `Code` button.
|
While you're on the `wiki` branch, click the `Sync Fork` text located right below the green `Code` button.
|
||||||
Depending on the status of your branch can the prompt show different outcomes:
|
Depending on the status of your branch can the prompt show different outcomes:
|
||||||
|
|
||||||
- `This branch is not behind the upstream PlaceholderAPI:wiki`
|
- `This branch is not behind the upstream PlaceholderAPI:wiki`
|
||||||
Your fork's `wiki` branch is up-to-date with the latest changes from Upstream (This Repository). You don't have to update anything.
|
Your fork's `wiki` branch is up-to-date with the latest changes from Upstream (This Repository). You don't have to update anything.
|
||||||
![upstream up-to-date](./img/readme/up-to-date.png)
|
![upstream up-to-date](./img/readme/up-to-date.png)
|
||||||
- `Fetch and merge <number> upstream commits from PlaceholderAPI:wiki`
|
- `This branch is out-of-date`
|
||||||
This is shown when your fork's branch is outdated and upstream (This Repository) has changes. Click the `Fetch and merge` button to fetch the latest commits and update your fork's `wiki` branch.
|
Your fork's `wiki` branch is outdated and should be updated. Press the "Update branch" button to do so.
|
||||||
![upstream needs update](./img/readme/needs-update.png)
|
![upstream needs update](./img/readme/needs-update.png)
|
||||||
|
|
||||||
### Commit changes
|
### Commit changes
|
||||||
@ -160,12 +163,17 @@ Here are the following rules:
|
|||||||
### Make a Pull request
|
### Make a Pull request
|
||||||
After you made your changes is it time to make a Pull request.
|
After you made your changes is it time to make a Pull request.
|
||||||
|
|
||||||
When you go to the upstream repository, should GitHub already show you a notification that you have commits to PR. Click the `Compare & pull request` button to proceed.
|
When you made changes to the branch should GitHub show you a prompt with a button saying "Compare & pull request". This prompt also shows up when you visit the upstream Repository while having changes on your fork.
|
||||||
|
Press the button to proceed.
|
||||||
|
|
||||||
![pr prompt](./img/readme/pr-prompt.png)
|
![pr prompt](./img/readme/pr-prompt.png)
|
||||||
|
|
||||||
By default will GitHub select the `master` branch as the target, which is not what we want. To fix this, click the button saying `base:master` and select the `wiki` branch.
|
By default will GitHub select the `master` branch as the target, which is not what we want. To fix this, click the button saying `base:master` and select the `wiki` branch.
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
> When the branch selection only shows branches and not the actual repositories does it mean that you're prompted to PR to your own fork.
|
||||||
|
> To fix this, press the "compare across forks" text shown, select `PlaceholderAPI/PlaceholderAPI` as the target repository (left side) and your fork as the source. Then select the wiki branch as mentioned above.
|
||||||
|
|
||||||
![create pr](./img/readme/create-pr.png)
|
![create pr](./img/readme/create-pr.png)
|
||||||
|
|
||||||
Finally, fill out the Pull request template and submit the Pull request.
|
Finally, fill out the Pull request template and submit the Pull request.
|
||||||
@ -174,6 +182,9 @@ Congratulations! You've successfully made a Pull request for the wiki.
|
|||||||
### Questions?
|
### Questions?
|
||||||
If you have any questions, do not hesitate to ask in the [HelpChat Discord][discord] or [open a new discussion][discussion] in this repository. We will be happy to help you.
|
If you have any questions, do not hesitate to ask in the [HelpChat Discord][discord] or [open a new discussion][discussion] in this repository. We will be happy to help you.
|
||||||
|
|
||||||
|
### Tools
|
||||||
|
A simple [online-tool][expansion-generator] is provided by Andre601 that allows you to create new entries for expansions in the wiki.
|
||||||
|
|
||||||
### Credits
|
### Credits
|
||||||
- The Wiki is maintained by [Andre601][andre].
|
- The Wiki is maintained by [Andre601][andre].
|
||||||
- We use the [GitHub Wiki Action][action] by [Andrew-Chen-Wang][andrew] to update the PlaceholderAPI wiki through GitHub Actions.
|
- We use the [GitHub Wiki Action][action] by [Andrew-Chen-Wang][andrew] to update the PlaceholderAPI wiki through GitHub Actions.
|
||||||
|
35
Using-Placeholders.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
This page is intended for server owners or server staff who want to learn how to use placeholders in a plugin.
|
||||||
|
|
||||||
|
If you're a developer and would like to learn how to provide placeholders or support placeholders from other plugins in your own, check out [[Hook into PlaceholderAPI]].
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
Before you can use placeholders should you check a few things first.
|
||||||
|
|
||||||
|
### Plugin supports PlaceholderAPI
|
||||||
|
The first and most important thing is, to find out if the plugin you want to use placeholders in is actually supporting PlaceholderAPI.
|
||||||
|
Chat-plugins such as EssentialsXChat do not natively support PlaceholderAPI and instead require separate plugins to "inject" the parsed placeholders into the final chat message.
|
||||||
|
|
||||||
|
One way to check, if a Plugin is supporing PlaceholderAPI, is to check the [[Plugins using PlaceholderAPI]] page.
|
||||||
|
If the plugin is listed and if the `Supports placeholders` text has a check, does it mean that PlaceholderAPI support is available.
|
||||||
|
|
||||||
|
If the plugin isn't listed, can you usually check its plugin page, or any other source of information, such as a wiki, for clues on if PlaceholderAPI is supported.
|
||||||
|
|
||||||
|
### Proper Internet connection
|
||||||
|
PlaceholderAPI connects towards an eCloud located under https://api.extendedclip.com to retrieve information about placeholder expansions, but also to download said expansions from it.
|
||||||
|
Make sure that your server is allowing external connections to the above URL. If it doesn't, and you're using a host, contact their support and ask them to whitelist this URL.
|
||||||
|
|
||||||
|
## Download/Get Expansion
|
||||||
|
The way PlaceholderAPI's system works, allows a Placeholder Expansion and its corresponding placeholders to either be included within a plugin (If placeholder requires said plugin) or to be available as a separate jar file on the eCloud of PlaceholderAPI.
|
||||||
|
Depending on what type you have, will you need to do some extra steps to use the placeholder from the Placeholder Expansion.
|
||||||
|
|
||||||
|
One way to find out, if an Expansion is included or separate, is to check the [[Placeholders]] page for any entry of it.
|
||||||
|
If it exists on the page, can you check, if the line right after the title says `NO DOWNLOAD COMMAND` or `/papi ecloud download ...` (i.e. `/papi ecloud download Player`).
|
||||||
|
|
||||||
|
If the line says the former, does it mean, the expansion is part of the plugin and doesn't need any extra steps to be active (Unless the plugin author mentions otherwise).
|
||||||
|
In the case of the later, will you need to download the expansion from the eCloud. Simply copy the command and execute it either in the console, or in-game. Afterwards, reload PlaceholderAPI using `/papi reload`.
|
||||||
|
|
||||||
|
You can check what expansions are loaded by running `/papi list`.
|
||||||
|
|
||||||
|
## Use Expansion
|
||||||
|
Using the placeholders of the Expansion is a straigh forward process.
|
||||||
|
Simply put the right placeholder format (i.e. `%player_name%`) inside whatever configuration option supports it. Please refer to any manuals or wikis a plugin may offer about what options support placeholders.
|
@ -15,7 +15,7 @@
|
|||||||
[versionImg]: https://img.shields.io/nexus/placeholderapi/me.clip/placeholderapi?server=https%3A%2F%2Frepo.extendedclip.com&label=API%20Version
|
[versionImg]: https://img.shields.io/nexus/placeholderapi/me.clip/placeholderapi?server=https%3A%2F%2Frepo.extendedclip.com&label=API%20Version
|
||||||
[plugin-page]: https://spigotmc.org/resources/6245
|
[plugin-page]: https://spigotmc.org/resources/6245
|
||||||
|
|
||||||
> © 2015 - 2021 [PlaceholderAPI Team][papi]
|
> © 2015 - 2023 [PlaceholderAPI Team][papi]
|
||||||
> Thanks for using PlaceholderAPI.
|
> Thanks for using PlaceholderAPI.
|
||||||
>
|
>
|
||||||
> **[Plugin-page]** | **[[Placeholders]]** | **[[Plugins using PlaceholderAPI]]** | **[[Hook into PlaceholderAPI]]**
|
> **[Plugin-page]** | **[[Placeholders]]** | **[[Plugins using PlaceholderAPI]]** | **[[Hook into PlaceholderAPI]]**
|
||||||
|
@ -5,6 +5,7 @@
|
|||||||
**[[Main page|Home]]**
|
**[[Main page|Home]]**
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
**[[Using Placeholders]]**
|
||||||
**[[Hook into PlaceholderAPI]]**
|
**[[Hook into PlaceholderAPI]]**
|
||||||
- [[First steps|Hook-into-PlaceholderAPI#first-steps]]
|
- [[First steps|Hook-into-PlaceholderAPI#first-steps]]
|
||||||
- [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]]
|
- [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]]
|
||||||
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 12 KiB |