diff --git a/.github/workflows/publish_site.yml b/.github/workflows/publish_site.yml index f17a43c..a10068c 100644 --- a/.github/workflows/publish_site.yml +++ b/.github/workflows/publish_site.yml @@ -57,11 +57,11 @@ jobs: - name: Build pages run: mkdocs build - name: Configure GitHub Pages - uses: actions/configure-pages@v4 + uses: actions/configure-pages@v5 - name: Upload Pages Artifact uses: actions/upload-pages-artifact@v3 with: path: 'site/' - name: Deploy to GitHub Pages uses: actions/deploy-pages@v4 - id: deployment \ No newline at end of file + id: deployment diff --git a/README.md b/README.md index d5b603f..f6bda40 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ $ git checkout -b It is now time to make your changes. It is recommended to use MkDocs and its live-preview feature to see your changes applied in real time whenever you save a file. -To use the live-preview, run `mkdocs serve` in the same folder where the `mkdocs.yml` file is located. This should start a server on `http://127.0.0.1:8000` that you can open in your browser. +To use the live-preview, run `mkdocs serve` in the same folder where the `mkdocs.yml` file is located. This should start a server on `http://127.0.0.1:8000` that you can open in your browser. You can also append the `--open` argument to the command to make MkDocs open the preview directly, avoiding the need of having to open it yourself. Should the command not work, check that you actually installed MkDocs and any required dependencies. The easiest way is to just execute `pip install mkdocs-material` to download the Material for MkDocs theme alongside additional dependencies, including MkDocs. To cancel the live preview, simply press Ctrl+C in the git-bash terminal to shut the live preview server down. @@ -164,28 +164,32 @@ The following rules apply to all pages: The following rules apply specifically to entries in the [Placeholder List][placeholder-list] page: -1. Entries need to be in alphabetical order. +1. Entries need to be in alphabetical order. - Should an entry with the name already exist will you need to add yours after it. -2. An entry follows this specific format: - ````markdown - - ### []() - > - - - - ``` - - ``` - ```` - - `` is the name of the Placeholder expansion you add. - - `` is a link to the plugin this expansion is made for. If the expansion is not for a plugin should no link be added (Only `- ### ` be used). - - Links to spigot pages need to be sanitized, meaning a link such as `https://www.spigotmc.org/resources/placeholderapi.6245/` becomes `https://www.spigotmc.org/resources/6245/` - - `` is the [`/papi ecloud download`][download-command] used to get the expansion. Should the expansion not be on the eCloud will you need to put `NO DOWNLOAD COMMAND` here. - - `` is an optional text that can be used to point to extra documentation. Please keep it short and simple. - - `` would be all available placeholders. Each entry should be on a new line. - - Please avoid explicit examples and instead use `<>` and `[]` to indicate required or optional values (i.e. instead of `%expansion_SomePlayer%` it would be `%expansion_%`) -3. Make sure to also add an entry to the list at the top of the page, linking to your entry. -4. Should your entry have entries before and/or after it will you need to add horizontal lines (`----`) to separate yours from these entries. Keep an empty line between the horizontal line and any entry. +2. An entry follows this specific format: + ````markdown + ### []() + /// + /// + + + + ``` + + ``` + ```` + - `` is the name of the Placeholder expansion you add. + - `` is a link to the plugin this expansion is made for. If the expansion is not for a plugin should no link be added (Only `- ### ` be used). + - Links to spigot pages need to be sanitized, meaning a link such as `https://www.spigotmc.org/resources/placeholderapi.6245/` becomes `https://www.spigotmc.org/resources/6245/` + - `` needs to be replaced with one of the following values, depending on how the expansion can be added: + - Should your expansion be built-in into a Plugin, add `integrated | Built into Plugin` + - Should your expansion be obtainable via the [`/papi ecloud download`][download-command] command, add `command | papi ecloud download ` + - Should your expansion only be downloadable via external sources (i.e. a GitHub Release), add `download | ` + - `` is an optional text that can be used to point to extra documentation. Please keep it short and simple. + - `` would be all available placeholders. Each entry should be on a new line. + - Please avoid explicit examples and instead use `<>` and `[]` to indicate required or optional values (i.e. instead of `%expansion_SomePlayer%` it would be `%expansion_%`) +3. Make sure to also add an entry to the list at the top of the page, linking to your entry. +4. Should your entry have entries before and/or after it will you need to add horizontal lines (`----`) to separate yours from these entries. Keep an empty line between the horizontal line and any entry. > A [online tool][papi-list-gen] exists for your convenience to create the markdown for a new entry. diff --git a/docs/assets/js/latest-release.js b/docs/assets/js/latest-release.js index b8a2716..84a6132 100644 --- a/docs/assets/js/latest-release.js +++ b/docs/assets/js/latest-release.js @@ -10,10 +10,12 @@ document$.subscribe(async => { } async function fetchAPIInfo() { - const release = await fetch("https://papi-repo-proxy.vercel.app/repo/latest-release").then(_ => _.json()); + const release = await fetch("https://repo.extendedclip.com/api/maven/latest/version/releases/me/clip/placeholderapi").then(_ => _.json()); + + console.log(release) const data = { - "version": release.name + "version": release.version } __md_set("__api_tag", data, sessionStorage); diff --git a/docs/assets/stylesheets/styling.css b/docs/assets/stylesheets/styling.css index af464bf..fa711d4 100644 --- a/docs/assets/stylesheets/styling.css +++ b/docs/assets/stylesheets/styling.css @@ -1,7 +1,65 @@ +:root { + --md-admonition-icon--command: url('data:image/svg+xml;charset=utf-8,'); + --md-admonition-icon--integrated: url('data:image/svg+xml;charset=utf-8,'); + --md-admonition-icon--download: url('data:image/svg+xml;charset=utf-8,'); +} + .md-header__button.md-logo img { height: 3rem; } .md-typeset .grid.cards.hide-list > ul > li > ul > li { list-style-type: none; +} + +/*************************** + * Custom Admonition boxes * + ***************************/ + +/* Command */ +.md-typeset .admonition.command, +.md-typeset details.command { + border-color: #00c853; +} +.md-typeset .command > .admonition-title, +.md-typeset .command > summary { + background-color: #00c8531a; +} +.md-typeset .command > .admonition-title::before, +.md-typeset .command > summary::before { + background-color: #00c853; + -webkit-mask-image: var(--md-admonition-icon--command); + mask-image: var(--md-admonition-icon--command); +} + +/* Integrated (built-in) */ +.md-typeset .admonition.integrated, +.md-typeset details.integrated { + border-color: #9e9e9e; +} +.md-typeset .integrated > .admonition-title, +.md-typeset .integrated > summary { + background-color: #9e9e9e1a; +} +.md-typeset .integrated > .admonition-title::before, +.md-typeset .integrated > summary::before { + background-color: #9e9e9e; + -webkit-mask-image: var(--md-admonition-icon--integrated); + mask-image: var(--md-admonition-icon--integrated); +} + +/* Download */ +.md-typeset .admonition.download, +.md-typeset details.download { + border-color: #00c853; +} +.md-typeset .download > .admonition-title, +.md-typeset .download > summary { + background-color: #00c8531a; +} +.md-typeset .download > .admonition-title::before, +.md-typeset .download > summary::before { + background-color: #00c853; + -webkit-mask-image: var(--md-admonition-icon--download); + mask-image: var(--md-admonition-icon--download); } \ No newline at end of file diff --git a/docs/developers/creating-a-placeholderexpansion.md b/docs/developers/creating-a-placeholderexpansion.md index b559a1a..0df5710 100644 --- a/docs/developers/creating-a-placeholderexpansion.md +++ b/docs/developers/creating-a-placeholderexpansion.md @@ -107,7 +107,7 @@ This method of creating a PlaceholderExpansion is recommended as it has the foll Internal PlaceholderExpansions are not automatically registered by PlaceholderAPI, due to them not being a separate jar file located in the expansion folder. Please see the [Regsister your Expansion](#register-your-expansion) section for more details. -You are also required to override and set `persistent()` to `true`. This tells PlaceholderAPI to not unload your expansion during plugin reload, as it would otherwise unregister your expansion, making it no longer work. +You are also required to override and set `persist()` to `true`. This tells PlaceholderAPI to not unload your expansion during plugin reload, as it would otherwise unregister your expansion, making it no longer work. /// /// details | Full Example diff --git a/docs/developers/using-placeholderapi.md b/docs/developers/using-placeholderapi.md index 2fe7c75..d03cc8c 100644 --- a/docs/developers/using-placeholderapi.md +++ b/docs/developers/using-placeholderapi.md @@ -18,7 +18,7 @@ Use the below code example matching your dependency manager. placeholderapi - https://repo.extendedclip.com/content/repositories/placeholderapi/ + https://repo.extendedclip.com/releases/ @@ -36,7 +36,7 @@ Use the below code example matching your dependency manager. ```{ .groovy title="build.gradle" data-md-component="api-version" } repositories { maven { - url = 'https://repo.extendedclip.com/content/repositories/placeholderapi/' + url = 'https://repo.extendedclip.com/releases/' } } @@ -62,27 +62,39 @@ Next step is to go to your plugin.yml or paper-plugin.yml and add PlaceholderAPI /// tab | :simple-spigotmc: plugin.yml //// tab | Optional dependency -```yaml + +///// note | +Tab the :material-plus-circle: icons in the code block below for additional information. +///// + +```{ .yaml .annotate title="plugin.yml" } name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here -# This sets PlaceholderAPI as an optional dependency for your plugin. -softdepend: [PlaceholderAPI] +softdepend: ["PlaceholderAPI"] # (1) ``` + +1. This sets PlaceholderAPI as an optional dependency for your plugin. //// //// tab | Required dependency -```yaml + +///// note | +Tab the :material-plus-circle: icons in the code block below for additional information. +///// + +```{ .yaml .annotate title="plugin.yml" } name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here -# This sets PlaceholderAPI as a required dependency for your plugin. -depend: [PlaceholderAPI] +depend: ["PlaceholderAPI"] # (1) ``` + +1. This sets PlaceholderAPI as a required dependency for your plugin. //// /// @@ -90,7 +102,12 @@ depend: [PlaceholderAPI] /// tab | :fontawesome-regular-paper-plane: paper-plugin.yml //// tab | Optional dependency -```yaml + +///// note | +Tab the :material-plus-circle: icons in the code block below for additional information. +///// + +```{ .yaml .annotate title="paper-plugin.yml" } name: ExamplePlugin version: 1.0 author: author @@ -99,14 +116,21 @@ main: your.main.path.Here dependencies: server: PlaceholderAPI: - # Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin. - load: BEFORE + load: BEFORE # (1) required: false ``` + +1. Load order is relative to the Dependency. + This means that in this example, PlaceholderAPI is loaded **before** your plugin. //// //// tab | Required dependency -```yaml + +///// note | +Tab the :material-plus-circle: icons in the code block below for additional information. +///// + +```{ .yaml .annotate title="paper-plugin.yml" } name: ExamplePlugin version: 1.0 author: author @@ -115,10 +139,12 @@ main: your.main.path.Here dependencies: server: PlaceholderAPI: - # Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin. - load: BEFORE + load: BEFORE # (1) required: true ``` + +1. Load order is relative to the Dependency. + This means that in this example, PlaceholderAPI is loaded **before** your plugin. //// /// @@ -134,10 +160,19 @@ To use placeholders from other plugins in our own plugin, we simply have to [(so It is also important to point out, that any required plugin/dependency for an expansion has to be on the server and enabled, or the `setPlaceholders` method will just return the placeholder itself (do nothing). -/// example +/// details | Example + type: example + Let's assume we want to send a custom join message that shows the primary group a player has. To achieve this, we can do the following: -```java + +//// note | +The below example assumes a **soft dependency** on PlaceholderAPI to handle PlaceholderAPI not being present more decently. + +Tab the :material-plus-circle: icons in the code block below for additional information. +//// + +```{ .java .annotate title="JoinExample.java" } package at.helpch.placeholderapi; import me.clip.placeholderapi.PlaceholderAPI; @@ -155,18 +190,10 @@ public class JoinExample extends JavaPlugin implements Listener { @Override public void onEnable() { - if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) { - /* - * We register the EventListener here, when PlaceholderAPI is installed. - * Since all events are in the main class (this class), we simply use "this" - */ - Bukkit.getPluginManager().registerEvents(this, this); + if (Bukkit.getPluginManager().isPluginEnabled("PlaceholderAPI")) { + Bukkit.getPluginManager().registerEvents(this, this); // (1) } else { - /* - * We inform about the fact that PlaceholderAPI isn't installed and then - * disable this plugin to prevent issues. - */ - getLogger().warn("Could not find PlaceholderAPI! This plugin is required."); + getLogger().warn("Could not find PlaceholderAPI! This plugin is required."); // (2) Bukkit.getPluginManager().disablePlugin(this); } } @@ -175,16 +202,17 @@ public class JoinExample extends JavaPlugin implements Listener { public void onJoin(PlayerJoinEvent event) { String joinText = "%player_name% joined the server! They are rank %vault_rank%"; - /* - * We parse the placeholders using "setPlaceholders" - * This would turn %vault_rank% into the name of the Group, that the - * joining player has, assuming Vault and the Vault expansion are - * on the server. - */ - joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText); + joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText); // (3) event.setJoinMessage(joinText); } } ``` + +1. We check that PlaceholderAPI is present and enabled to then register events to handle (See below). +2. In case PlaceholderAPI is not present are we reporting this issue and disable the plugin. +3. Using `PlaceholderAPI.setPlaceholders(Player, String)` we can parse `%placeholder%` text in the provided String, should they have a matching expansion and said expansion return a non-null String. + In our example are we providing a text containing `%player_name%` and `%vault_rank%` to be parsed, which require the Player and Vault expansion respectively. + + Example output: `Notch joined the server! They are rank Admin` /// diff --git a/docs/users/placeholder-list.md b/docs/users/placeholder-list.md index 925972d..8817c97 100644 --- a/docs/users/placeholder-list.md +++ b/docs/users/placeholder-list.md @@ -6,8 +6,8 @@ description: Community-curated list of available PlaceholderExpansions and their This is a list of all available placeholders. -A download-command for the extension can be found at the area of the placeholder. -If the command itself isn't there and `NO DOWNLOAD COMMAND` instead is shown, then it means, that the plugin actually has the placeholders hard-coded into them and doesn't require a manual download of any expansion. +A download-command may be found in the infobox located below the title of the Expansion. +Should `Built into Plugin` be displayed is the Expansion included in the Plugin it depends on. Should a URL be shown does it mean you have to download it manually and add it to the `expansions` folder yourself. /// note This placeholder list is provided "as-is" without any guarantee of being accurate and/or up-to-date. @@ -174,6 +174,7 @@ Further details on how to contribute to this list or the wiki as a whole can be - **[ChatColor+ Premium](#chatcolor-premium)** - **[ChatReaction](#chatreaction)** - **[CheckNameHistory](#checknamehistory)** + - **[ClaimChunk](#claimchunk)** - **[Clans](#clans)** - **[ClansFree](#clansfree)** - **[Clans-API for Spigot/Clan tag in chat](#clans-api-for-spigotclan-tag-in-chat)** @@ -348,7 +349,7 @@ Further details on how to contribute to this list or the wiki as a whole can be - **[Quests](#quests)** - **[QuestCreator](#questcreator)** - **[QuickSell](#quicksell)** - + - **R** - **[RabbitsVSPenguins](#rabbitsvspenguins)** - **[RageMode](#ragemode)** @@ -458,1048 +459,1086 @@ Further details on how to contribute to this list or the wiki as a whole can be Expansions listed here don't need any plugin or extra library to function properly, unless mentioned otherwise. A majority of these Expansions are maintained by the PlaceholderAPI team and can be considered *official*. -- ### **Advancements** - > /papi ecloud download Advancements - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/matahombres/Advancements). - - ``` - %Advancements_% - %Advancements_player_;% - %Advancements_list% - %Advancements_list_% - %Advancements_playerList_% - %Advancements_playerList_,% - %Advancements_listFormat% - %Advancements_playerListFormat_% - %Advancements_completedAmount% - %Advancements_completedAmount_% - %Advancements_playerCompletedAmount_% - %Advancements_playerCompletedAmount_,% - %Advancements_remainingAmount% - %Advancements_remainingAmount_% - %Advancements_playerRemainingAmount_% - %Advancements_playerRemainingAmount_,% - ``` +### **Advancements** +/// command | papi ecloud download Advancements +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/matahombres/Advancements). + +``` +%advancements_% +%advancements_player_;% +%advancements_list% +%advancements_list_% +%advancements_playerList_% +%advancements_playerList_,% +%advancements_listFormat% +%advancements_playerListFormat_% +%advancements_completedAmount% +%advancements_completedAmount_% +%advancements_playerCompletedAmount_% +%advancements_playerCompletedAmount_,% +%advancements_remainingAmount% +%advancements_remainingAmount_% +%advancements_playerRemainingAmount_% +%advancements_playerRemainingAmount_,% +``` ---- -- ### **Animations** - > /papi ecloud download Animations - - ``` - %animations_Text% - %animations_Text% - %animations_Text% - ``` - - Please note: When using placeholders within the animation text, you must use the bracket variant. - Use `{player_name}` instead of `%player_name%` within the ` ` tags. - - Please visit the [dedicated wiki](https://github.com/Niall7459/KiteBoard-Documentation/wiki/Animations-and-Modifiers) for all available tags. +### **Animations** +/// command | papi ecloud download Animations +/// + +``` +%animations_Text% +%animations_Text% +%animations_Text% +``` + +Please note: When using placeholders within the animation text, you must use the bracket variant. +Use `{player_name}` instead of `%player_name%` within the ` ` tags. + +Please visit the [dedicated wiki](https://github.com/Niall7459/KiteBoard-Documentation/wiki/Animations-and-Modifiers) for all available tags. ---- -- ### **Armor** - > /papi ecloud download Armor - - Gives you info about your armor - - ``` - Chose one value that's inside () and replace SLOT with one of the following: helmet, chestplate, leggings, boots. - - %armor_amount_SLOT% - %armor_color_(red/green/blue/hex)_SLOT% - %armor_durability_(left/max)_SLOT% - %armor_has_SLOT% - %armor_material_SLOT% - %armor_maxamount_SLOT% - ``` +### **Armor** +/// command | papi ecloud download Armor +/// + +Gives you info about your armor + +``` +Chose one value that's inside () and replace SLOT with one of the following: helmet, chestplate, leggings, boots. + +%armor_amount_SLOT% +%armor_color_(red/green/blue/hex)_SLOT% +%armor_durability_(left/max)_SLOT% +%armor_has_SLOT% +%armor_material_SLOT% +%armor_maxamount_SLOT% +``` ---- -- ### **ASCII** - > /papi ecloud download ASCII - - Returns the [ASCII Value](http://www.asciitable.com/) based on input - - ``` - %ascii_% - ``` - - Ex: `%ascii_37%` returns `%` +### **ASCII** +/// command | papi ecloud download ASCII +/// + +Returns the [ASCII Value](http://www.asciitable.com/) based on input + +``` +%ascii_% +``` + +Ex: `%ascii_37%` returns `%` ---- -- ### **Attribute** - > /papi ecloud download Attribute - - Adds placeholders to access [Attributes](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html). ([Minecraft wiki](https://minecraft.wiki/w/Attribute)) - **The expansion can be used only on 1.9+** - - ``` - // Available for all game versions - %attribute_player_has_% - whether the player has a certain attribute - %attribute_player_baseValue_% - returns the base value of an attribute - %attribute_player_value_% - returns the value of an attribute with all the modifiers applied - - // 1.11+ - %attribute_player_defaultValue_% - returns the default value of an attribute - ``` +### **Attribute** +/// command | papi ecloud download Attribute +/// + +Adds placeholders to access [Attributes](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html). ([Minecraft wiki](https://minecraft.wiki/w/Attribute)) +**The expansion can be used only on 1.9+** + +``` +// Available for all game versions +%attribute_player_has_% - whether the player has a certain attribute +%attribute_player_baseValue_%- returns the base value of an attribute +%attribute_player_value_%- returns the value of an attribute with all the modifiers applied + +// 1.11+ +%attribute_player_defaultValue_% - returns the default value of an attribute +``` ---- -- ### **BungeeCord** - > /papi ecloud download Bungee - - Allows you to show, how many players are online on the entire network, or just on a specific server. - - ``` - %bungee_total% - %bungee_% - ``` +### **BungeeCord** +/// command | papi ecloud download Bungee +/// + +Allows you to show, how many players are online on the entire network, or just on a specific server. + +``` +%bungee_total% +%bungee_% +``` ---- -- ### **CalculateNumbers** - > NO DOWNLOAD COMMAND - - Download the jar from [broken1arrow/CalculateNumbers/releases](https://github.com/broken1arrow/CalculateNumbers/releases) - - The idea with this expansion is that you should be able to charge dynamically, - for example in the deluxe menu. For tools, weapons - and armor when players need to - repair their belongings. Has also added optional so you can also combine it with - rank plugin if - you have one. - - Use decimal,to get two decimal digits. - - ``` - %number_numbervalue,tool:{a placeholder from your ranking plugin}% - %number_numbervalue,decimal,tool:{a placeholder from your ranking plugin}% - %number_numbervalue,armor:{a placeholder from your ranking plugin}% - %number_numbervalue,decimal,armor:{a placeholder from your ranking plugin}% - ``` +### **CalculateNumbers** +/// download | https://github.com/broken1arrow/CalculateNumbers/releases +/// + +The idea with this expansion is that you should be able to charge dynamically, +for example in the deluxe menu. For tools, weapons +and armor when players need to +repair their belongings. Has also added optional so you can also combine it with +rank plugin if +you have one. + +Use decimal,to get two decimal digits. + +``` +%number_numbervalue,tool:{a placeholder from your ranking plugin}% +%number_numbervalue,decimal,tool:{a placeholder from your ranking plugin}% +%number_numbervalue,armor:{a placeholder from your ranking plugin}% +%number_numbervalue,decimal,armor:{a placeholder from your ranking plugin}% +``` ---- -- ### **ChangeOutput** - > /papi ecloud download changeoutput - - Allows you to change the output based on what other placeholders return. - - More information can be found on the [GitHub Repository](https://github.com/Kqliber/Expansion-ChangeOutput) - - ``` - %changeoutput__input:_matcher:_ifmatch:_else:% - ``` - - * `` - * equals - match the input exactly - * ignorecase - match the input while ignoring cases - * ignorecolor - match the input while ignoring colour codes - * contains - check if the match contains input - * \>= - check if the input is larger than or equal to the matcher - * \> - check if the input is larger than the matcher - * <= - check if the input is less than or equal to the matcher - * < - check if the input is less than the matcher - * `` - this is your text that you wish to replace - * `` - this is the text we will be looking for to meet the conditions - * `` - if the input meets the condition, this text will be displayed - * `` - if the input does not meet the condition, this text will be displayed instead - - *All arguments can be replaced with other placeholders, wrapped in* `{}` +### **ChangeOutput** +/// command | papi ecloud download changeoutput +/// + +Allows you to change the output based on what other placeholders return. + +More information can be found on the [GitHub Repository](https://github.com/Kqliber/Expansion-ChangeOutput) + +``` +%changeoutput__input:_matcher:_ifmatch:_else:% +``` + +- `` +- equals - match the input exactly +- ignorecase - match the input while ignoring cases +- ignorecolor - match the input while ignoring colour codes +- contains - check if the match contains input +- \>= - check if the input is larger than or equal to the matcher +- \> - check if the input is larger than the matcher +- <= - check if the input is less than or equal to the matcher +- < - check if the input is less than the matcher +- `` - this is your text that you wish to replace +- `` - this is the text we will be looking for to meet the conditions +- `` - if the input meets the condition, this text will be displayed +- `` - if the input does not meet the condition, this text will be displayed instead + +*All arguments can be replaced with other placeholders, wrapped in* `{}` ---- -- ### **CheckItem** - > /papi ecloud download CheckItem - - Allows you to check the inventory of a player for a certain item. - - ``` - %checkitem_,,<...>% - Returns if user has the item - %checkitem_amount_,,<...>% - Returns amount of items the user has - %checkitem_remove_,,<...>% - Removes the items from the players inventory - Can be used with amount, it just has to be after. (Ex. %checkitem_amount_remove_<...>%) Please be careful as it does REMOVE ITEMS FOR GOOD - %checkitem_give_,,<...>% - Gives the player items. Returns true if successful, returns the number of items NOT given if unsuccessful. (When unsuccessful items can still be given, it just might not be all of them) - %checkitem_getinfo:_,,<...>% - Returns information about an item in a slot. Returns information in the same order listed on this wiki. List is seperated via " &r" (Ex. %checkitem_getinfo:0_mat:) - ``` - - *Notes:* - *- `mainhand` and `offhand` work in `getinfo:`* - *- `give` and `remove` placeholders are **DISABLED** by default for **security purposes**. See PlaceholderAPI `config.yml` file to enable.* - - **Modifiers** - You can combine different modifiers to check for different values. - Available modifiers are: - - - `namecontains:` - Checks if the item's display name contains ``* \*\* ~ - - `namestartswith:` - Checks if the item's display name starts with ``* \*\* ~ - - `nameequals:` - Checks if the item's display name equals ``* \*\* ^ ~ - - `mat:` - Checks if the item is `` (For example: `STONE`) ^ ~ - - `amt:` - Checks if the player has `` of items ^ ~ - - `data:` - Checks if the item has data `` (Example: Red wool has `14` as data (`WOOL:14`)). - This is only for 1.12 and older! ^ ~ - - `custommodeldata:` - Checks if the item has CustomModelData `` - This is only for 1.14 and newer! ^ ~ - - `lorecontains:` - Checks if the item's lore contains ``* ~ - ***Combined with `getinfo` you can specify a number for `` and the specific lore line will be returned*** - - `loreequals:` - Checks if the item's lore equals `` Lines are separated by `|` ^ ~ - ***Combined with `getinfo` you can specify a number for `` and the specific lore line will be returned*** - - `matcontains:` - Checks if the item's material contains ``* - - `enchantments:;` - Checks if the item's enchantments contains `` with an optional `=level` - Uses vanilla minecraft enchantment names ^ ~ - - `enchanted` - Checks if the item is enchanted (with anything) ~ - - `potiontype:` - Checks if the item has the potiontype ([Click here for potion types](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html)) ^ ~ - - `potionextended:` - Checks if a potion is extended ^ ~ - - `potionupgraded:` - Checks if a potion is upgraded ^ ~ - - `strict` - 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` - 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:` - Check if the item is in a specific slot ([Click here for valid slots](https://i.imgur.com/3YCrfC8.png)) - - `nbtstrings:=;=` - Checks if the item's nbtStrings contains `` with the value of ``. * ^ ~ - - `nbtints:=;=` - Checks if the item's nbtInts contains `` with the value of ``. * ^ ~ - - *For nbt data you can use compounds by putting `..` inside your string Example (`%checkitem_nbtstrings:PublicBukkitValues..executableitems:ei-id=Free_Money%`)* ^ - - **Notes:** - - - \* means case-sensitive - - ** means only one can be used - - ^ means that the modifier supports the `give` placeholder - - ~ means that the modifier works with the `getinfo` placeholder - - To use Commas in strings you must escape them using `\` (Ex: `loreequals:Milk\, Eggs\, Bread`) - - **Placeholders are supported, but they need to be in brackets! (Ex: `%player_name%` would be `{player_name}`** +### **CheckItem** +/// command | papi ecloud download CheckItem +/// + +Allows you to check the inventory of a player for a certain item. + +``` +%checkitem_,,<...>%- Returns if user has the item +%checkitem_amount_,,<...>% - Returns amount of items the user has +%checkitem_remove_,,<...>% - Removes the items from the players inventory - Can be used with amount, it just has to be after. (Ex. %checkitem_amount_remove_<...>%) Please becareful as it does REMOVE ITEMS FOR GOOD +%checkitem_give_,,<...>% - Gives the player items. Returns true if successful, returns the number of items NOT given if unsuccessful. (When unsuccessful items can still begiven, it just might not be all of them) +%checkitem_getinfo:_,,<...>% - Returns information about an item in a slot. Returns information in the same order listed on this wiki. List is seperated via " &r" (Ex. %checkitem_getinfo:0_mat:) +``` + +*Notes:* +*- `mainhand` and `offhand` work in `getinfo:`* +*- `give` and `remove` placeholders are **DISABLED** by default for **security purposes**. See PlaceholderAPI `config.yml` file to enable.* + +**Modifiers** +You can combine different modifiers to check for different values. +Available modifiers are: + +- `namecontains:` + Checks if the item's display name contains ``* \*\* ~ +- `namestartswith:` + Checks if the item's display name starts with ``* \*\* ~ +- `nameequals:` + Checks if the item's display name equals ``* \*\* ^ ~ +- `mat:` + Checks if the item is `` (For example: `STONE`) ^ ~ +- `amt:` + Checks if the player has `` of items ^ ~ +- `data:` + Checks if the item has data `` (Example: Red wool has `14` as data (`WOOL:14`)). + This is only for 1.12 and older! ^ ~ +- `custommodeldata:` + Checks if the item has CustomModelData `` + This is only for 1.14 and newer! ^ ~ +- `lorecontains:` + Checks if the item's lore contains ``* ~ + ***Combined with `getinfo` you can specify a number for `` and the specific lore line will be returned*** +- `loreequals:` + Checks if the item's lore equals `` Lines are separated by `|` ^ ~ + ***Combined with `getinfo` you can specify a number for `` and the specific lore line will be returned*** +- `matcontains:` + Checks if the item's material contains ``* +- `enchantments:;` + Checks if the item's enchantments contains `` with an optional `=level` + Uses vanilla minecraft enchantment names ^ ~ +- `enchanted` + Checks if the item is enchanted (with anything) ~ +- `potiontype:` + Checks if the item has the potiontype ([Click here for potion types](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html)) ^ ~ +- `potionextended:` + Checks if a potion is extended ^ ~ +- `potionupgraded:` + Checks if a potion is upgraded ^ ~ +- `strict` + 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` + 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:` + Check if the item is in a specific slot ([Click here for valid slots](https://i.imgur.com/3YCrfC8.png)) +- `nbtstrings:=;=` + Checks if the item's nbtStrings contains `` with the value of ``. * ^ ~ +- `nbtints:=;=` + Checks if the item's nbtInts contains `` with the value of ``. * ^ ~ + + *For nbt data you can use compounds by putting `..` inside your string Example (`%checkitem_nbtstrings:PublicBukkitValues..executableitems:ei-id=Free_Money%`)* ^ + +**Notes:** + +- \* means case-sensitive +- ** means only one can be used +- ^ means that the modifier supports the `give` placeholder +- ~ means that the modifier works with the `getinfo` placeholder +- To use Commas in strings you must escape them using `\` (Ex: `loreequals:Milk\, Eggs\, Bread`) +- **Placeholders are supported, but they need to be in brackets! (Ex: `%player_name%` would be `{player_name}`** ---- -- ### **CooldownBar** - > /papi ecloud download CooldownBar - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/CooldownBar-Expansion). - - ``` - %cooldownbar_{placeholder}% - %cooldownbar_{placeholder}_p:% - %cooldownbar_{placeholder}_i:% - %cooldownbar_{placeholder}_r:% - %cooldownbar_{placeholder}_l:% - %cooldownbar_{placeholder}_c:% - %cooldownbar_{placeholder}_rdy:% - %cooldownbar_{essentials_kit_time_until_available_tools}_p:&a■_i:&e■_r:&7■_l:5_c:100_rdy:&aReadytoclaim!% - %cooldownbar_percentage_{placeholder}% - %cooldownbar_percentage_{placeholder}_c:% - %cooldownbar_percentage_{placeholder}_d:% - %cooldownbar_percentage_{essentials_kit_time_until_available_tools}_c:120_d:0% - ``` +### **CooldownBar** +/// command | papi ecloud download CooldownBar +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/CooldownBar-Expansion). + +``` +%cooldownbar_{placeholder}% +%cooldownbar_{placeholder}_p:% +%cooldownbar_{placeholder}_i:% +%cooldownbar_{placeholder}_r:% +%cooldownbar_{placeholder}_l:% +%cooldownbar_{placeholder}_c:% +%cooldownbar_{placeholder}_rdy:% +%cooldownbar_{essentials_kit_time_until_available_tools}_p:&a■_i:&e■_r:&7■_l:5_c:100_rdy:&aReadytoclaim!% +%cooldownbar_percentage_{placeholder}% +%cooldownbar_percentage_{placeholder}_c:% +%cooldownbar_percentage_{placeholder}_d:% +%cooldownbar_percentage_{essentials_kit_time_until_available_tools}_c:120_d:0% +``` ---- -- ### **Enchantment** - > NO DOWNLOAD COMMAND (Download it from [here](https://github.com/TeamVK/PAPI-Enchantment/releases)) - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/TeamVK/PAPI-Enchantment). - - `<>` is required. - - ``` - %enchantment_list% # a list of enchantments on the item a player is holding (separated by ',') - %enchantment_listLF% # a list of enchantments on the item a player is holding (separated by '\n') - %enchantment_roman_list% # a list of enchantments on the item a player is holding (separated by ',') - %enchantment_roman_listLF% # a list of enchantments on the item a player is holding (separated by '\n') - %enchantment__level% # a level of the specified enchantment on the item a player is holding - ``` +### **Enchantment** +/// download | https://github.com/TeamVK/PAPI-Enchantment/releases +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/TeamVK/PAPI-Enchantment). + +`<>` is required. + +``` +%enchantment_list% # a list of enchantments on the item a player is holding (separated by ',') +%enchantment_listLF% # a list of enchantments on the item a player is holding (separated by '\n') +%enchantment_roman_list% # a list of enchantments on the item a player is holding (separated by ',') +%enchantment_roman_listLF% # a list of enchantments on the item a player is holding (separated by '\n') +%enchantment__level% # a level of the specified enchantment on the item a player is holding +%enchantment__total% # a total level (sum) of the specified enchantment on the item a player is holding and wearing. +``` ---- -- ### **Formatter** - > /papi ecloud download Formatter - - More info about this expansion can be found on the [Codeberg-Repository](https://codeberg.org/Andre601/Formatter-Expansion). - - `[]` is optional and `<>` is required. - Use `{{u}}` for underscores and `{{prc}}` for percent symbols. - - ``` - %formatter_number_format_% - %formatter_number_format_[locale]:[pattern]_% - %formatter_number_from:_to:_% - %formatter_number_round_% - %formatter_number_round_[precision]:[roundingmode]_% - %formatter_number_shorten_% - %formatter_number_time_% - %formatter_number_time__% # Handles number as - - %formatter_text_capitalize_% - %formatter_text_length_% - %formatter_text_lowercase_% - %formatter_text_replace_[target]_[replacement]_% - %formatter_text_substring_[start]:[end]_% - %formatter_text_uppercase_% - ``` +### **Formatter** +/// command | papi ecloud download Formatter +/// + +More info about this expansion can be found on the [Codeberg-Repository](https://codeberg.org/Andre601/Formatter-Expansion). + +`[]` is optional and `<>` is required. +Use `{{u}}` for underscores and `{{prc}}` for percent symbols. + +``` +%formatter_number_format_% +%formatter_number_format_[locale]:[pattern]_% +%formatter_number_from:_to:_% +%formatter_number_round_% +%formatter_number_round_[precision]:[roundingmode]_% +%formatter_number_shorten_% +%formatter_number_time_% +%formatter_number_time__% # Handles number as + +%formatter_text_capitalize_% +%formatter_text_length_% +%formatter_text_lowercase_% +%formatter_text_replace_[target]_[replacement]_% +%formatter_text_substring_[start]:[end]_% +%formatter_text_uppercase_% +``` ---- -- ### **[GraalJS](https://github.com/ruViolence/GraalJS-Expansion)** - > /papi ecloud download GraalJS - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/ruViolence/GraalJS-Expansion). - - ``` - %graaljs_% - %graaljs__arg1% - %graaljs__arg1,arg2,arg3% - ``` +### **[GraalJS](https://github.com/ruViolence/GraalJS-Expansion)** +/// command | papi ecloud download GraalJS +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/ruViolence/GraalJS-Expansion). + +``` +%graaljs_% +%graaljs__arg1% +%graaljs__arg1,arg2,arg3% +``` ---- -- ### **[Javascript](https://api.extendedclip.com/expansions/javascript/)** - > NO DOWNLOAD COMMAND - - /// danger | Unverified - Due to potential security issues is this expansion currently unverified. Use at your own risk. - /// - - Gives you a way, to use javascript, to give a different output, depending on conditions. - - ``` - %javascript_% - ``` +### **[Javascript](https://api.extendedclip.com/expansions/javascript/)** +/// failure | Unverified +Due to potential security issues is this expansion currently unverified. Use at your own risk. +/// + +Gives you a way, to use javascript, to give a different output, depending on conditions. + +``` +%javascript_% +``` ---- -- ### **ListPlayers** - > /papi ecloud download ListPlayers - - Lists players with a certain permission or in a certain world... 'nuf said. - - ``` - %listplayers_with_perm_% - %listplayers_in_world_% - ``` +### **ListPlayers** +/// command | papi ecloud download ListPlayers +/// + +Lists players with a certain permission or in a certain world... 'nuf said. + +``` +%listplayers_with_perm_% +%listplayers_in_world_% +``` ---- -- ### **LocalTime** - > /papi ecloud download LocalTime - - ``` - %localtime_time% - %localtime_time_% - %localtime_timezone_% - %localtime_timezone_,% - ``` - - Please read the [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html) Javadoc page about possible formats and [this post](https://garygregory.wordpress.com/2013/06/18/what-are-the-java-timezone-ids/) about available time zone IDs for ``. +### **LocalTime** +/// command | papi ecloud download LocalTime +/// + +``` +%localtime_time% +%localtime_time_% +%localtime_timezone_% +%localtime_timezone_,% +``` + +Please read the [SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html) Javadoc page about possible formats and [this post](https://garygregory.wordpress.com/2013/06/18/what-are-the-java-timezone-ids/) about available time zone IDs for ``. ---- -- ### **Math** - > /papi ecloud download Math - - Allows simple and advanced mathematical equations. - Any placeholder that returns a number is supported (Use `{placeholder}` instead of `%placeholder%`) - - Supports all calculations you can do with [EvalEx](https://github.com/uklimaschewski/EvalEx). - Note that the `%` can't be used within the placeholder and that you have to use `[prc]` instead. - - ``` - %math_% - %math_[precision]:[rounding]_% - ``` +### **Math** +/// command | papi ecloud download Math +/// + +Allows simple and advanced mathematical equations. +Any placeholder that returns a number is supported (Use `{placeholder}` instead of `%placeholder%`) + +Supports all calculations you can do with [EvalEx](https://ezylang.github.io/EvalEx/). Note that the `%` can't be used within the placeholder and that you have to use `[prc]` instead. + +*More info on [Codeberg](https://codeberg.org/Andre601/Math-Expansion)* + +``` +%math_% +%math_[precision]:[rounding]_% +``` ---- -- ### **MVdW Placeholders** - > /papi ecloud download MVdW - - Lets you use placeholders from [MVdWPlaceholderAPI](https://www.spigotmc.org/resources/11182/). - MVdWPlaceholderAPI and one of **[Maxims plugins](https://www.spigotmc.org/resources/2691/)**, that use it, are required! - A list of his placeholders can be found [here](https://www.spigotmc.org/wiki/mvdw-placeholders/) - - ``` - %mvdw_% - ``` +### **MVdW Placeholders** +/// command | papi ecloud download MVdW +/// + +Lets you use placeholders from [MVdWPlaceholderAPI](https://www.spigotmc.org/resources/11182/). +MVdWPlaceholderAPI and one of **[Maxims plugins](https://www.spigotmc.org/resources/2691/)**, that use it, are required! +A list of his placeholders can be found [here](https://www.spigotmc.org/wiki/mvdw-placeholders/) + +``` +%mvdw_% +``` ---- -- ### **MySQL** - > NO DOWNLOAD COMMAND - - /// danger | Unverified - Due to possible security concerns is this expansion currently unverified. Use at your own risk. - /// - - ``` - %mysql_% - ``` - - `` is a set query that can be found in the config.yml under `plugins/PlaceholderAPI/expansion/MySQL`. +### **MySQL** +/// failure | Unverified +Due to possible security concerns is this expansion currently unverified. Use at your own risk. +/// + +``` +%mysql_% +``` + +`` is a set query that can be found in the config.yml under `plugins/PlaceholderAPI/expansion/MySQL`. ---- -- ### **MySQLTokens** - > NO DOWNLOAD COMMAND - - ``` - %mysqltokens_tokens% - ``` +### **MySQLTokens** +/// integrated | Built into Plugin +/// + +``` +%mysqltokens_tokens% +``` ---- -- ### **NumberFormatter** - > Download it from [here](https://github.com/TeamVK/PAPI-NumberFormatter/releases) - - More info about this expansion can be found on the [PAPI-NumberFormatter](https://github.com/TeamVK/PAPI-NumberFormatter). - - For instance: - - if %tokenenchant_token_long% returns 43535709321,
- %nf_4X_tokenenchant_token_long% will return 43B,
- %nf_###E0X_tokenenchant_token_long% will return 43.5B,
- %nf_#,##0.#_tokenenchant_token_long% will return 43,535,709,321
- %nf_#,##0.0#:IT_tokenenchant_token_long% will return 43.535.709.321.0
- - `[]` is optional and `<>` is required. - - ``` - %nf_[:locale]_% # Converts a number produced by %other_placeholder% to a number using the specified format. - ``` +### **NumberFormatter** +/// download | https://github.com/TeamVK/PAPI-NumberFormatter/releases +/// + +More info about this expansion can be found on the [PAPI-NumberFormatter](https://github.com/TeamVK/PAPI-NumberFormatter). + +For instance: + +if %tokenenchant_token_long% returns 43535709321,
+%nf_4X_tokenenchant_token_long% will return 43B,
+%nf_###E0X_tokenenchant_token_long% will return 43.5B,
+%nf_#,##0.#_tokenenchant_token_long% will return 43,535,709,321
+%nf_#,##0.0#:IT_tokenenchant_token_long% will return 43.535.709.321.0
+ +`[]` is optional and `<>` is required. + +``` +%nf_[:locale]_% # Converts a number produced by %other_placeholder% to a number using the specified format. +``` ---- -- ### **OtherPlayer** - > /papi ecloud download OtherPlayer - - Lets you get placeholders for other players. (Not the one that triggers the action) - - ``` - %otherplayer_displayname_% - %otherplayer_gamemode_% - %otherplayer_hasperm__perm_% - %otherplayer_haspotioneffect__effect_% - %otherplayer_health_% - %otherplayer_hunger_% - %otherplayer_iteminhand_% - %otherplayer_ip_% - %otherplayer_level_% - %otherplayer_locx_% - %otherplayer_locy_% - %otherplayer_locz_% - %otherplayer_oxygen_% - %otherplayer_spells_% - %otherplayer_uuid_% - %otherplayer_world_% - ``` +### **OtherPlayer** +/// command | papi ecloud download OtherPlayer +/// + +Lets you get placeholders for other players. (Not the one that triggers the action) + +``` +%otherplayer_displayname_% +%otherplayer_gamemode_% +%otherplayer_hasperm__perm_% +%otherplayer_haspotioneffect__effect_% +%otherplayer_health_% +%otherplayer_hunger_% +%otherplayer_iteminhand_% +%otherplayer_ip_% +%otherplayer_level_% +%otherplayer_locx_% +%otherplayer_locy_% +%otherplayer_locz_% +%otherplayer_oxygen_% +%otherplayer_spells_% +%otherplayer_uuid_% +%otherplayer_world_% +``` ---- -- ### **ParseNear** - > /papi ecloud download ParseNear - - Lets you parse any placeholder for the closest player. Will return blank if no player is found. - - ``` - %parsenear_% # Parses placeholder for closest player - %parsenear__% # Parses placeholder for closest player in a radius - ``` +### **ParseNear** +/// command | papi ecloud download ParseNear +/// + +Lets you parse any placeholder for the closest player. Will return blank if no player is found. + +``` +%parsenear_% # Parses placeholder for closest player +%parsenear__% # Parses placeholder for closest player in a radius +``` ---- -- ### **ParseOther** - > /papi ecloud download ParseOther - - Lets you parse any placeholder for another player. - You must use the unsafe placeholder to parse placeholders for `username` or `uuid`. - Make sure to include the `{}` brackets, as it won't work without them. - - ``` - %parseother_{username}_{placeholder_without_percent_signs}% - %parseother_unsafe_{placeholder_for_username}_{placeholder_without_percent_signs}% - %parseother_{uuid}_{placeholder_without_percent_signs}% - %parseother_unsafe_{placeholder_for_uuid}_{placeholder_without_percent_signs}% - ``` +### **ParseOther** +/// command | papi ecloud download ParseOther +/// + +Lets you parse any placeholder for another player. +You must use the unsafe placeholder to parse placeholders for `username` or `uuid`. +Make sure to include the `{}` brackets, as it won't work without them. + +``` +%parseother_{username}_{placeholder_without_percent_signs}% +%parseother_unsafe_{placeholder_for_username}_{placeholder_without_percent_signs}% +%parseother_{uuid}_{placeholder_without_percent_signs}% +%parseother_unsafe_{placeholder_for_uuid}_{placeholder_without_percent_signs}% +``` ---- -- ### **Pinger** - > /papi ecloud download Pinger - - Lets you ping a server through an IP or domain (with port), to check the online-status and to receive some information. - The placeholders have a "warmup" time of around one or two minutes after installing the expansion. - - **Note**: These placeholders have a separate update-delay in the config.yml of PlaceholderAPI - - Replace `testplugins.com:25565` with your own server/IP. - ``` - %pinger_gameversion_testplugins.com:25565% - %pinger_version_testplugins.com:25565% - %pinger_online_testplugins.com:25565% - %pinger_isonline_testplugins.com:25565% - %pinger_max_testplugins.com:25565% - %pinger_players_testplugins.com:25565% - %pinger_motd_testplugins.com:25565% - %pinger_pingversion_testplugins.com:25565% - ``` - `%pinger_online_testplugins.com:25565%` and `%pinger_isonline_testplugins.com:25565%` do the exact same thing. +### **Pinger** +/// command | papi ecloud download Pinger +/// + +Lets you ping a server through an IP or domain (with port), to check the online-status and to receive some information. +The placeholders have a "warmup" time of around one or two minutes after installing the expansion. + +**Note**: These placeholders have a separate update-delay in the config.yml of PlaceholderAPI + +Replace `testplugins.com:25565` with your own server/IP. +``` +%pinger_gameversion_testplugins.com:25565% +%pinger_version_testplugins.com:25565% +%pinger_online_testplugins.com:25565% +%pinger_isonline_testplugins.com:25565% +%pinger_max_testplugins.com:25565% +%pinger_players_testplugins.com:25565% +%pinger_motd_testplugins.com:25565% +%pinger_pingversion_testplugins.com:25565% +``` +`%pinger_online_testplugins.com:25565%` and `%pinger_isonline_testplugins.com:25565%` do the exact same thing. ---- -- ### **Player** - > /papi ecloud download Player - - Gives you various placeholders for the player, that triggers the action. - - ``` - %player_allow_flight% - %player_armor_helmet_name% - %player_armor_helmet_data% - %player_armor_helmet_durability% - %player_armor_chestplate_name% - %player_armor_chestplate_data% - %player_armor_chestplate_durability% - %player_armor_leggings_name% - %player_armor_leggings_data% - %player_armor_leggings_durability% - %player_armor_boots_name% - %player_armor_boots_data% - %player_armor_boots_durability% - %player_bed_x% - %player_bed_y% - %player_bed_z% - %player_bed_world% - %player_biome% - %player_biome_capitalized% - %player_block_underneath% - %player_can_pickup_items% - %player_colored_ping% - %player_compass_world% - %player_compass_x% - %player_compass_y% - %player_compass_z% - %player_custom_name% - %player_current_exp% - %player_direction% - %player_direction_xz% - %player_displayname% - %player_list_name% - %player_exp% - %player_exp_to_level% - %player_first_join_date% - %player_first_played% - %player_first_join% - %player_first_played_formatted% - %player_fly_speed% - %player_food_level% - %player_gamemode% - %player_has_empty_slot% - %player_has_played_before% - %player_empty_slots% - %player_has_health_boost% - %player_has_potioneffect_% - %player_has_permission_% - %player_health% - %player_health_boost% - %player_health_rounded% - %player_health_scale% - %player_ip% - %player_online% - %player_is_whitelisted% - %player_is_banned% - %player_is_flying% - %player_is_sneaking% - %player_is_sprinting% - %player_is_sleeping% - %player_is_inside_vehicle% - %player_is_op% - %player_item_in_hand% - %player_item_in_hand_name% - %player_item_in_hand_data% - %player_item_in_hand_durability% - %player_item_in_hand_level_% - %player_item_in_offhand% - %player_item_in_offhand_name% - %player_item_in_offhand_data% - %player_item_in_offhand_durability% - %player_item_in_offhand_level_% - %player_locale% - %player_locale_display_name% - %player_locale_short% - %player_locale_country% - %player_locale_display_country% - %player_last_damage% - %player_last_played% - %player_last_join% - %player_last_played_formatted% - %player_last_join_date% - %player_level% - %player_light_level% - %player_max_air% - %player_max_health% - %player_max_health_rounded% - %player_max_no_damage_ticks% - %player_minutes_lived% - %player_name% - %player_no_damage_ticks% - %player_ping% - %player_ping_% - %player_remaining_air% - %player_saturation% - %player_seconds_lived% - %player_sleep_ticks% - %player_thunder_duration% - %player_ticks_lived% - %player_time% - %player_time_offset% - %player_total_exp% - %player_uuid% - %player_walk_speed% - %player_weather_duration% - %player_world% - %player_world_type% - %player_world_time_12% - %player_world_time_24% - %player_x% - %player_y% - %player_z% - %player_yaw% - %player_pitch% - %player_absorption% - ``` +### **Player** +/// command | papi ecloud download Player +/// + +Gives you various placeholders for the player, that triggers the action. + +``` +%player_allow_flight% +%player_armor_helmet_name% +%player_armor_helmet_data% +%player_armor_helmet_durability% +%player_armor_chestplate_name% +%player_armor_chestplate_data% +%player_armor_chestplate_durability% +%player_armor_leggings_name% +%player_armor_leggings_data% +%player_armor_leggings_durability% +%player_armor_boots_name% +%player_armor_boots_data% +%player_armor_boots_durability% +%player_bed_x% +%player_bed_y% +%player_bed_z% +%player_bed_world% +%player_biome% +%player_biome_capitalized% +%player_block_underneath% +%player_can_pickup_items% +%player_colored_ping% +%player_compass_world% +%player_compass_x% +%player_compass_y% +%player_compass_z% +%player_custom_name% +%player_current_exp% +%player_direction% +%player_direction_xz% +%player_displayname% +%player_list_name% +%player_exp% +%player_exp_to_level% +%player_first_join_date% +%player_first_played% +%player_first_join% +%player_first_played_formatted% +%player_fly_speed% +%player_food_level% +%player_gamemode% +%player_has_empty_slot% +%player_has_played_before% +%player_empty_slots% +%player_has_health_boost% +%player_has_potioneffect_% +%player_has_permission_% +%player_health% +%player_health_boost% +%player_health_rounded% +%player_health_scale% +%player_ip% +%player_online% +%player_is_whitelisted% +%player_is_banned% +%player_is_flying% +%player_is_sneaking% +%player_is_sprinting% +%player_is_sleeping% +%player_is_inside_vehicle% +%player_is_op% +%player_item_in_hand% +%player_item_in_hand_name% +%player_item_in_hand_data% +%player_item_in_hand_durability% +%player_item_in_hand_level_% +%player_item_in_offhand% +%player_item_in_offhand_name% +%player_item_in_offhand_data% +%player_item_in_offhand_durability% +%player_item_in_offhand_level_% +%player_locale% +%player_locale_display_name% +%player_locale_short% +%player_locale_country% +%player_locale_display_country% +%player_last_damage% +%player_last_played% +%player_last_join% +%player_last_played_formatted% +%player_last_join_date% +%player_level% +%player_light_level% +%player_max_air% +%player_max_health% +%player_max_health_rounded% +%player_max_no_damage_ticks% +%player_minutes_lived% +%player_name% +%player_no_damage_ticks% +%player_ping% +%player_ping_% +%player_remaining_air% +%player_saturation% +%player_seconds_lived% +%player_sleep_ticks% +%player_thunder_duration% +%player_ticks_lived% +%player_time% +%player_time_offset% +%player_total_exp% +%player_uuid% +%player_walk_speed% +%player_weather_duration% +%player_world% +%player_world_type% +%player_world_time_12% +%player_world_time_24% +%player_x% +%player_y% +%player_z% +%player_yaw% +%player_pitch% +%player_absorption% +``` ---- -- ### PlayerList - > /papi ecloud download playerlist - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/Tanguygab/PlayerList-PlaceholderAPI-Expansion/wiki). - - Create a list in PAPI's config and retrieve it through placeholders! - ``` - %playerlist__% - ``` +### PlayerList +/// command | papi ecloud download playerlist +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/Tanguygab/PlayerList-PlaceholderAPI-Expansion/wiki). + +Create a list in PAPI's config and retrieve it through placeholders! +``` +%playerlist__% +``` ---- -- ### **Plugin** - > /papi ecloud download Plugin - - Returns information about the specified plugin. - - ``` - %plugin_isenabled_% - %plugin_isdisabled_% - %plugin_exists_% - ``` +### **Plugin** +/// command | papi ecloud download Plugin +/// + +Returns information about the specified plugin. + +``` +%plugin_isenabled_% +%plugin_isdisabled_% +%plugin_exists_% +``` ---- -- ### **Progress** - > /papi ecloud download progress - - More info about this expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/Progress-Expansion). - - ``` - %progress_bar_{placeholder}% - %progress_bar_{placeholder}_c:% - %progress_bar_{placeholder}_p:% - %progress_bar_{placeholder}_r:% - %progress_bar_{placeholder}_l:% - %progress_bar_{placeholder}_m:% - %progress_bar_{placeholder}_fullbar:% - - # Example - %progress_bar_{placeholder}_c:&a■_p:&e■_r:&7■_l:10_m:100_fullbar:&aCompleted!% - ``` +### **Progress** +/// command | papi ecloud download progress +/// + +More info about this expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/Progress-Expansion). + +``` +%progress_bar_{placeholder}% +%progress_bar_{placeholder}_c:% +%progress_bar_{placeholder}_p:% +%progress_bar_{placeholder}_r:% +%progress_bar_{placeholder}_l:% +%progress_bar_{placeholder}_m:% +%progress_bar_{placeholder}_fullbar:% + +# Example +%progress_bar_{placeholder}_c:&a■_p:&e■_r:&7■_l:10_m:100_fullbar:&aCompleted!% +``` ---- -- ### **RainbowColor** - > /papi ecloud download RainbowColor - - More info about the expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/RainbowColor-Expansion). - - ``` - %RainbowColor_% - %RainbowColor_custom_,,_% - - e.g. %RainbowColor_custom_a,f,e,b_This is an example% - ``` +### **RainbowColor** +/// command | papi ecloud download RainbowColor +/// + +More info about the expansion can be found on the [GitHub-Repository](https://github.com/aBo0oDyy/RainbowColor-Expansion). + +``` +%RainbowColor_% +%RainbowColor_custom_,,_% + +e.g. %RainbowColor_custom_a,f,e,b_This is an example% +``` ---- -- ### **RandomColor** - > /papi ecloud download RandomColor - - More info about the expansion can be found on the [GitHub-Repository](https://github.com/Andre601/RandomColor). - - ``` - %randomcolor_all% - %randomcolor_color% - %randomcolor_combined% - %randomcolor_format% - %randomcolor_selected_% - ``` +### **RandomColor** +/// command | papi ecloud download RandomColor +/// + +More info about the expansion can be found on the [GitHub-Repository](https://github.com/Andre601/RandomColor). + +``` +%randomcolor_all% +%randomcolor_color% +%randomcolor_combined% +%randomcolor_format% +%randomcolor_selected_% +``` ---- -- ### **RandomNumber** - > Download it from [here](https://github.com/TeamVK/PAPI-RandomNumber/releases) - - More info about the expansion can be found on the [GitHub-Repository](https://github.com/TeamVK/PAPI-RandomNumber). - - It returns an auto-scaled random number. If you did not specify the scale, the scale will be automatically computed. If both min and max are integer numbers, the returned random number will also be an integer. - - ``` - %randomnumber_value% - %randomnumber_value_scale% - %randomnumber_value_min_max% - %randomnumber_value_min_max_scale% - ``` +### **RandomNumber** +/// download | https://github.com/TeamVK/PAPI-RandomNumber/releases +/// + +More info about the expansion can be found on the [GitHub-Repository](https://github.com/TeamVK/PAPI-RandomNumber). + +It returns an auto-scaled random number. If you did not specify the scale, the scale will be automatically computed. If both min and max are integer numbers, the returned random number will also be an integer. + +``` +%randomnumber_value% +%randomnumber_value_scale% +%randomnumber_value_min_max% +%randomnumber_value_min_max_scale% +``` ---- -- ### **RedisBungee** - > /papi ecloud download RedisBungee - - Same like the [BungeeCord-placeholders](#bungeecord), but for RedisBungee - - ``` - %redisbungee_total% - %redisbungee_% - ``` +### **RedisBungee** +/// command | papi ecloud download RedisBungee +/// + +Same like the [BungeeCord-placeholders](#bungeecord), but for RedisBungee + +``` +%redisbungee_total% +%redisbungee_% +``` ---- -- ### **RelCon** - > /papi ecloud download RelCon - - More info about the expansion can be found on the [GitHub-Repository](https://github.com/PlaceholderAPI/RelCon-Expansion). - - ``` - %rel_relcon_player___[text2]% - %rel_relcon_player__% - %rel_relcon_viewer___[text2]% - %rel_relcon_viewer__% - ``` +### **RelCon** +/// command | papi ecloud download RelCon +/// + +More info about the expansion can be found on the [GitHub-Repository](https://github.com/PlaceholderAPI/RelCon-Expansion). + +``` +%rel_relcon_player___[text2]% +%rel_relcon_player__% +%rel_relcon_viewer___[text2]% +%rel_relcon_viewer__% +``` ---- -- ### **RNG** - > /papi ecloud download RNG - - More info about the expansion can be found on the [GitHub-Repository](https://github.com/Kqliber/Expansion-RNG). - - ``` - %rng_online_player% - %rng_random% - %rng_,% - ``` +### **RNG** +/// command | papi ecloud download RNG +/// + +More info about the expansion can be found on the [GitHub-Repository](https://github.com/Kqliber/Expansion-RNG). + +``` +%rng_online_player% +%rng_random% +%rng_,% +``` ---- -- ### **ScoreboardObjectives** - > /papi ecloud download ScoreboardObjectives - - Get info from a scoreboard objective. - - More info about the expansion can be found on the [Spigot Page](https://www.spigotmc.org/resources/placeholderapi-scoreboard-objectives-placeholder.48236/) - - ``` - %objective_displayname_{}% - %objective_score_{}% - %objective_score_{}_{[otherEntry]}% - %objective_scorep_{}% - %objective_scorep_{}_{[otherPlayer]}% - %objective_scoreposhigh_{}_{<#>}% - %objective_scoreposlow_{}_{<#>}% - %objective_entryposhigh_{}_{<#>}% - %objective_entryposlow_{}_{<#>}% - ``` +### **ScoreboardObjectives** +/// command | papi ecloud download ScoreboardObjectives +/// + +Get info from a scoreboard objective. + +More info about the expansion can be found on the [Spigot Page](https://www.spigotmc.org/resources/placeholderapi-scoreboard-objectives-placeholder.48236/) + +``` +%objective_displayname_{}% +%objective_score_{}% +%objective_score_{}_{[otherEntry]}% +%objective_scorep_{}% +%objective_scorep_{}_{[otherPlayer]}% +%objective_scoreposhigh_{}_{<#>}% +%objective_scoreposlow_{}_{<#>}% +%objective_entryposhigh_{}_{<#>}% +%objective_entryposlow_{}_{<#>}% +``` ---- -- ### **Server** - > /papi ecloud download Server - - Lets you get information about the server. - - ``` - %server_name% - %server_online% - %server_version% - %server_max_players% - %server_unique_joins% - %server_uptime% - %server_ram_used% - %server_ram_free% - %server_ram_total% - %server_ram_max% - %server_tps% - %server_tps_1% - %server_tps_5% - %server_tps_15% - %server_tps_1_colored% - %server_tps_5_colored% - %server_tps_15_colored% - %server_online_% - %server_has_whitelist% - %server_total_chunks% - %server_total_living_entities% - %server_total_entities% - %server_time_% - %server_countdown__