Compare commits

...

26 Commits

Author SHA1 Message Date
Funnycube
c53e17fb8b Add more Hytale placeholders 2026-02-06 19:59:47 +11:00
Funnycube
9e059af87c Merge pull request #1164 from PlaceholderAPI/feat/wiki-fix-hytale-stuff
Feat/wiki fix hytale stuff
2026-02-06 18:23:59 +11:00
Funnycube
45d52d124f fix hytale example 2026-02-06 18:19:48 +11:00
Funnycube
85665f1089 remove non existent depend 2026-02-06 18:10:54 +11:00
Andre_601
8c69b02fca Missed an entry (To lazy to reopen terminal) 2026-02-03 00:57:07 +01:00
Andre601
9a96b7bb2d Add missing links to expansions + make format consistent 2026-02-03 00:55:00 +01:00
Andre601
b2cb1447ce Fix broken/overriten nav and links 2026-02-03 00:48:08 +01:00
Funnycube
72110cacb3 cmd update 2026-02-02 20:37:52 +11:00
Funnycube
48780dedbb add ecloud block 2026-02-02 20:35:20 +11:00
Funnycube
8313755aa0 copyright 2026-02-02 20:04:47 +11:00
Funnycube
7538080806 add modrinth 2026-02-02 20:04:23 +11:00
Funnycube
bc00425d68 Merge pull request #1158 from PlaceholderAPI/feature/wiki-add-component-info
[Wiki] Add info on new Component support
2026-02-02 19:19:10 +11:00
PiggyPiglet
8673466ad0 fixed typo and added example 2026-02-02 16:18:24 +08:00
Andre601
39769506c2 Update Info 2026-01-31 15:04:08 +01:00
Andre_601
5bc6f17ab5 Merge pull request #1161 from PlaceholderAPI/feat/wiki-hytale-placeholders-list
Add Hytale Placeholders List
2026-01-31 14:40:12 +01:00
Funnycube
b0e02d4755 Improve clarity of placeholder list introduction 2026-02-01 00:34:48 +11:00
Funnycube
13d1ae8336 Fix grammar in Placeholder Expansions description
Corrected grammar in the description of Placeholder Expansions.
2026-02-01 00:30:17 +11:00
Funnycube
d654cce5c1 cap 2
Corrected capitalization of 'Version' to 'version' in the Minecraft placeholders documentation.
2026-02-01 00:29:03 +11:00
Funnycube
6b78ec0da2 cap 2026-02-01 00:28:27 +11:00
Andre601
447ccd925c Add Hytale Placeholders List 2026-01-31 14:22:30 +01:00
Andre_601
b3825b5c45 Merge pull request #1160 from PlaceholderAPI/feat/wiki-add-hytale-docs
Add Hytale-related docs
2026-01-31 13:32:26 +01:00
Funnycube
431e0234c2 Update PlaceholderAPI version requirements in docs 2026-01-31 21:12:53 +11:00
Funnycube
589135a9f4 Fix grammar in PlaceholderExpansion documentation
Corrected minor grammatical errors in the documentation.
2026-01-31 21:10:35 +11:00
Andre601
a32c6e4df0 Add Hytale-related docs 2026-01-26 13:52:39 +01:00
Andre601
bd6928414d [Wiki] Add info on new Component support 2026-01-18 18:00:56 +01:00
Andre_601
27cee54915 Merge pull request #1156 from PlaceholderAPI/wiki-updated-domains
Updated Domains!
2026-01-13 03:52:34 +01:00
15 changed files with 1061 additions and 317 deletions

View File

@@ -1,6 +1,6 @@
<div class="md-copyright">
<div class="md-copyright__highlight">
&copy; 2015 - 2024 PlaceholderAPI Team and Contributors.<br>
&copy; 2015 - 2025 PlaceholderAPI Team and Contributors.<br>
All content is licensed under
<a href="https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/LICENSE" target="_blank" rel="noopener">
<span class="twemoji">{% include ".icons/octicons/law-16.svg" %}</span> GNU GPL v3.0

View File

@@ -2,20 +2,27 @@ document$.subscribe(async => {
const api_code = document.querySelectorAll('[data-md-component="api-version"]');
function loadAPIInfo(data) {
const version = data["version"];
const versionToken = "{version}";
const mcVersion = data["mcVersion"];
const hyVersion = data["hyVersion"];
const mcVersionToken = "{papiVersion}";
const hyVersionToken = "{papiHytaleVersion}"
for (const codeBlock of api_code) {
codeBlock.innerHTML = codeBlock.innerHTML.replace(new RegExp(versionToken, 'g'), version);
codeBlock.innerHTML = codeBlock.innerHTML
.replace(new RegExp(mcVersionToken, 'g'), mcVersion)
.replace(new RegExp(hyVersionToken, 'g'), hyVersion);
}
}
async function fetchAPIInfo() {
const release = await fetch("https://repo.extendedclip.com/api/maven/latest/version/releases/me/clip/placeholderapi").then(_ => _.json());
console.log(release)
const [mcRelease, hyRelease] = await Promise.all([
fetch("https://repo.extendedclip.com/api/maven/latest/version/releases/me/clip/placeholderapi").then(_ => _.json()),
fetch("https://repo.helpch.at/api/maven/latest/version/releases/at/helpch/placeholderapi-hytale").then(_ => _.json())
])
const data = {
"version": release.version
"mcVersion": mcRelease.version,
"hyVersion": hyRelease.version
}
__md_set("__api_tag", data, sessionStorage);
@@ -24,7 +31,7 @@ document$.subscribe(async => {
if(location.href.includes("/developers/using-placeholderapi")) {
const cachedApi = __md_get("__api_tag", sessionStorage);
if ((cachedApi != null) && (cachedApi["version"])) {
if ((cachedApi != null) && (cachedApi["mcVersion"])) {
loadAPIInfo(cachedApi);
} else {
fetchAPIInfo();

View File

@@ -4,6 +4,13 @@ description: Comprehensive guide on how to create a PlaceholderExpansion for oth
# Creating a PlaceholderExpansion
/// warning | Important
These pages cover the creation of a PlaceholderExpansion for both Spigot/Paper-based and Hytale Servers!
Unless mentioned otherwise the provided code examples function for both platform types.
Please always check code blocks for :material-plus-circle: Icons with additional info!
///
This page will cover how you can create your own [`PlaceholderExpansion`][placeholderexpansion] which you can either integrate into your own plugin (Recommended) or [upload to the eCloud](expansion-cloud.md).
It's worth noting that PlaceholderAPI relies on expansions being installed. PlaceholderAPI only acts as the core replacing utility while the expansions allow other plugins to use any installed placeholder in their own messages.
@@ -74,6 +81,11 @@ public class SomeExpansion extends PlaceholderExpansion {
public String onPlaceholderRequest(Player player, @NotNull String params) {
// (5)
}
@Override
public String onPlaceholderRequest(PlayerRef player, @NotNull String params) {
// (6)
}
}
```
@@ -108,6 +120,16 @@ public class SomeExpansion extends PlaceholderExpansion {
- `player` - Nullable Player instance to parse placeholders against.
- `params` - Non-null String representing the part of the placeholder after the first `_` and before the closing `%` (or `}` for bracket placeholders).
6. **Note:** Only exists for the Hytale Version of PlaceholderAPI!
Called by PlaceholderAPI through `onPlaceholderRequest(PlayerRef, String)` to have placeholder values parsed.
When `null` is returned will PlaceholderAPI treat it as invalid placeholder and return it unchanged.
**Parameters:**
- `player` - PlayerRef instance to parse placeholders against.
- `params` - Non-null String representing the part of the placeholder after the first `_` and before the closing `%` (or `}` for bracket placeholders).
/// note
Overriding `onRequest(OfflinePlayer, String)` or `onPlaceholderRequest(Player, String)` is not required if you [create relational placeholders](#making-a-relational-expansion).
///
@@ -133,16 +155,18 @@ You are also required to override and set `persist()` to `true`. This tells Plac
attrs: { id: full-example-internal }
type: example
//// note |
Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
//// note | Important Notes
- Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
- The below example is for a Spigot/Paper-based setup.
For a Hytale server, replace `me.clip` imports with `at.helpch` and replace `OfflinePlayer` with `PlayerRef` (Including the import).
Tab the :material-plus-circle: icons in the code block below for additional information.
////
```java { .annotate title="SomeExpansion.java" }
package at.helpch.placeholderapi.example.expansion;
package com.example.plugin.expansion;
import at.helpch.placeholderapi.example.SomePlugin;
import com.example.plugin.SomePlugin;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
@@ -206,19 +230,20 @@ public class SomeExpansion extends PlaceholderExpansion {
6. Example of accessing data of the plugin's `config.yml` file.
7. Reaching this means that an invalid params String was given, so we return `null` to tell PlaceholderAPI that the placeholder was invalid.
///
### Register your Expansion
Due to the PlaceholderExpansion being internal, PlaceholderAPI does not load it automatically, we'll need to do it manually.
This is being done by creating a new instance of your PlaceholderExpansion class and calling the `register()` method of it.
This is being done by creating a new instance of your PlaceholderExpansion class and calling the `register()` method of it:
Here is a quick example:
/// tab | Spigot, Paper, ...
```java { .annotate title="SomePlugin.java" }
package at.helpch.placeholderapi.example;
package com.example.plugin;
import at.helpch.placeholderapi.example.expansion.SomeExpansion;
import com.example.plugin.expansion.SomeExpansion;
import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin;
@@ -238,6 +263,37 @@ public class SomePlugin extends JavaPlugin {
2. This registers our expansion in PlaceholderAPI. It also gives the Plugin class as dependency injection to the Expansion class, so that we can use it.
///
/// tab | Hytale
```java { .annotate title="SomePlugin.java" }
package com.example.plugin;
import com.example.plugin.expansion.SomeExpansion;
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
import com.hypixel.hytale.common.plugin.PluginIdentifier;
import com.hypixel.hytale.server.core.HytaleServer;
public class SomePlugin extends JavaPlugin {
public SomePlugin(JavaPluginInit init) {
super(init)
}
@Override
protected void start() {
if (HytaleServer.get().getPluginManager().getPlugin(PluginIdentifier.fromString("HelpChat:PlaceholderAPI")) != null) {
new SomeExpansion(this).register();
}
}
}
```
///
----
## Making an External Expansion
@@ -257,8 +313,10 @@ Downsides include a more tedious setup in terms of checking for a required plugi
attrs: { id: full-example-external-no-dependency }
type: example
//// note |
Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
//// note | Important Notes
- Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
- The below example is for a Spigot/Paper-based setup.
For a Hytale server, replace `me.clip` imports with `at.helpch` and replace `OfflinePlayer` with `PlayerRef` (Including the import).
Tab the :material-plus-circle: icons in the code block below for additional information.
////
@@ -266,7 +324,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
This is an example expansion without any plugin dependency.
```java { .annotate title="SomeExpansion.java" }
package at.helpch.placeholderapi.example.expansion;
package com.example.expansion;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.OfflinePlayer;
@@ -314,8 +372,10 @@ public class SomeExpansion extends PlaceholderExpansion {
attrs: { id: full-example-external-dependency }
type: example
//// note |
Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
//// note | Important Notes
- Please see the [Basic PlaceholderExpansion Structure](#basic-placeholderexpansion-structure) section for an explanation of all common methods in this example.
- The below example is for a Spigot/Paper-based setup.
For a Hytale server, replace `me.clip` imports with `at.helpch` and replace `OfflinePlayer` with `PlayerRef` (Including the import).
Tab the :material-plus-circle: icons in the code block below for additional information.
////
@@ -323,9 +383,9 @@ Tab the :material-plus-circle: icons in the code block below for additional info
This is an example expansion with a plugin dependency.
```java { .annotate title="SomeExpansion.java" }
package at.helpch.placeholderapi.example.expansion;
package com.example.expansion;
import at.helpch.placeholderapi.example.SomePlugin;
import com.example.plugin.SomePlugin;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer;
@@ -383,7 +443,9 @@ public class SomeExpansion extends PlaceholderExpansion {
2. The name of the plugin this expansion depends on.
It is recommended to set this, as it would result in PlaceholderAPI reporting any missing plugin for your expansion.
3. This does two things:
3. **Note:** This only works on a Spigot/Paper-based server. A equivalent for Hytale servers is not yet known.
This does two things:
1. It sets the `plugin` instance to `SomePlugin` using Bukkit's PluginManager to retrieve a JavaPlugin instance that is cast to `SomePlugin`.
2. It checks if the retrieved instance is not null. If it is will this result in `canRegister()` returning false, resulting in PlaceholderAPI not loading our expansion.
@@ -399,8 +461,9 @@ public class SomeExpansion extends PlaceholderExpansion {
## Making a relational Expansion
/// note
Relational Placeholders always start with `rel_` to properly identify them. This means that if you make a relational placeholder called `friends_is_friend` would the full placeholder be `%rel_friends_is_friend%`.
/// note | Notes
- Relational Placeholders always start with `rel_` to properly identify them. This means that if you make a relational placeholder called `friends_is_friend` would the full placeholder be `%rel_friends_is_friend%`.
- For Hytale, replace any mention of `Player` with `PlayerRef` and update any Imports in the code to `at.helpch` and related Hytale ones.
///
Relational PlaceholderExpansions are special in that they take two players as input, allowing you to give outputs based on their relation to each other.

View File

@@ -6,33 +6,35 @@ description: Guide on how to use PlaceholderAPI in your own plugin.
This page is about using PlaceholderAPI in your own plugin, to either let other plugins use your plugin, or just use placeholders from other plugins in your own.
Please note, that the examples in this page are only available for **PlaceholderAPI 2.10.0 or higher**!
Please note, that the examples in this page are only available for **PlaceholderAPI 2.10.0 (1.0.0 for Hytale version) or newer**!
## First steps
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
Use the below code example matching your dependency manager.
### Add PlaceholderAPI to your Project
/// tab | :simple-apachemaven: Maven
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
Use the below code example matching your project type and dependency manager.
/// tab | Minecraft (Spigot, Paper, ...)
//// tab | :simple-apachemaven: Maven
```{ .xml title="pom.xml" data-md-component="api-version" }
<repositories>
<repository>
<id>placeholderapi</id>
<url>https://repo.extendedclip.com/releases/</url>
<url>https://repo.helpch.at/releases/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId>
<version>{version}</version>
<scope>provided</scope>
<groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId>
<version>{papiVersion}</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
///
////
/// tab | :simple-gradle: Gradle
//// tab | :simple-gradle: Gradle
```{ .groovy title="build.gradle" data-md-component="api-version" }
repositories {
maven {
@@ -41,15 +43,68 @@ repositories {
}
dependencies {
compileOnly 'me.clip:placeholderapi:{version}'
compileOnly 'me.clip:placeholderapi:{papiVersion}'
// Optional: Component support on Paper Servers (Since 2.12.0)
compileOnly 'me.clip:placeholderapi-paper:{papiVersion}'
}
```
////
///
/// details | What is `{version}`?
/// tab | Hytale
//// tab | :simple-apachemaven: Maven
```{ .xml title="pom.xml" data-md-component="api-version" }
<repositories>
<repository>
<id>hytale</id>
<url>https://repo.codemc.io/repository/hytale/</url>
</repository>
<repository>
<id>placeholderapi</id>
<url>https://repo.helpch.at/releases/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<!-- Replace {hytaleVersion} with the version you need -->
<groupId>com.hypixel.hytale</groupId>
<artifactId>Server</artifactId>
<version>{hytaleVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>at.helpch</groupId>
<artifactId>placeholderapi-hytale</artifactId>
<version>{papiHytaleVersion}</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
////
//// tab | :simple-gradle: Gradle
```{ .groovy title="build.gradle" data-md-component="api-version" }
repositories {
maven {
url = 'https://repo.codemc.io/repository/hytale/'
url = 'https://repo.helpch.at/releases/'
}
}
dependencies {
// Replace {hytaleVersion} with the version you need.
compileOnly 'com.hypixel.hytale:Server:{hytaleVersion}'
compileOnly 'at.helpch:placeholderapi-hytale:{papiHytaleVersion}'
}
```
////
///
/// details | What is `{papiVersion}`/`{papiHytaleVersion}`?
type: question
Using Javascript, `{version}` is replaced with the latest available API version of PlaceholderAPI.
Using Javascript, `{papiVersion}` and `{papiHytaleVersion}` is replaced with the latest available API version of PlaceholderAPI for Minecraft and Hytale respectively.
Should you see the placeholder as-is does it mean that you either block Javascript, or that the version couldn't be obtained in time during page load.
You can always find the latest version matching the API version on the [releases tab](https://github.com/PlaceholderAPI/PlaceholderAPI/releases) of the GitHub Repository.
@@ -71,7 +126,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
main: com.example.plugin.ExamplePlugin
softdepend: ["PlaceholderAPI"] # (1)
```
@@ -89,7 +144,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
main: com.example.plugin.ExamplePlugin
depend: ["PlaceholderAPI"] # (1)
```
@@ -111,7 +166,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
main: com.example.plugin.ExamplePlugin
dependencies:
server:
@@ -134,7 +189,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
main: com.example.plugin.ExamplePlugin
dependencies:
server:
@@ -149,6 +204,42 @@ dependencies:
///
/// tab | manifest.json (Hytale)
//// tab | Optional dependency
```{ .json .annotate title="manifest.json" }
{
"Group": "com.example",
"Name": "ExamplePlugin",
"Version": "1.0",
"Main": "com.example.plugin.ExamplePlugin",
"OptionalDependencies": {
"HelpChat:PlaceholderAPI": ">= 1.0.2"
}
}
```
////
//// tab | Required dependency
```{ .json .annotate title="manifest.json" }
{
"Group": "com.example",
"Name": "ExamplePlugin",
"Version": "1.0",
"Main": "com.example.plugin.ExamplePlugin",
"Dependencies": {
"HelpChat:PlaceholderAPI": ">= 1.0.2"
}
}
```
////
///
## Adding placeholders to PlaceholderAPI
A full guide on how to create expansions can be found on the [Creating a PlaceholderExpansion](creating-a-placeholderexpansion.md) page.
@@ -156,15 +247,23 @@ A full guide on how to create expansions can be found on the [Creating a Placeho
## Setting placeholders in your plugin
PlaceholderAPI offers the ability, to automatically parse placeholders from other plugins within your own plugin, giving the ability for your plugin to support thousands of other placeholders without depending on each plugin individually.
To use placeholders from other plugins in our own plugin, we simply have to [(soft)depend on PlaceholderAPI](#set-placeholderapi-as-softdepend) and use the `setPlaceholders` method.
To use placeholders from other plugins in your own plugin, you simply have to [(soft)depend on PlaceholderAPI](#set-placeholderapi-as-softdepend) and use the `setPlaceholders` method.
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).
/// details | Example
type: example
/// info | New since 2.12.0
Starting with version 2.12.0 is it now possible to provide Components from the Adventure library to have placeholders parsed in.
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:
In order to use this new feature are the following things required to be true:
- You depend on `placeholderapi-paper` and not just `placeholderapi`
- Your plugin runs on a Paper-based Server. Spigot-based servers will not work!
- You use `PAPIComponent` instead of `PlaceholderAPI` to parse Components.
///
/// tab | Spigot, Paper, ...
The following is an example plugin that sends `%player_name% joined the server! They are rank %vault_rank%` as the Join message, having the placeholders be replaced by PlaceholderAPI.
//// note |
The below example assumes a **soft dependency** on PlaceholderAPI to handle PlaceholderAPI not being present more decently.
@@ -173,7 +272,7 @@ Tab the :material-plus-circle: icons in the code block below for additional info
////
```{ .java .annotate title="JoinExample.java" }
package at.helpch.placeholderapi;
package com.example.plugin;
import me.clip.placeholderapi.PlaceholderAPI;
@@ -215,4 +314,51 @@ public class JoinExample extends JavaPlugin implements Listener {
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`
//// info | New since 2.12.0
Using `placeholderapi-papi` and `PAPIComponents` instead of `PlaceholderAPI` allows you to parse placeholders inside Adventure Components.
////
///
/// tab | Hytale
The following is an example plugin that sends `Welcome %player_name%!` as the Join message, having the placeholders be replaced by PlaceholderAPI.
Keeping in mind the [Hytale Player Expansion](https://ecloud.placeholderapi.com/expansions/player-hytale/) needs to be installed to make use of `%player_<identifier>%` placeholders.
``` { .java .annotate title="JoinExample.java" }
packate com.example.plugin;
import at.helpch.placeholderapi.PlaceholderAPI;
import com.hypixel.hytale.server.core.event.events.player.PlayerReadyEvent;
import com.hypixel.hytale.server.core.Message;
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
import com.hypixel.hytale.server.core.universe.Universe;
public class JoinExample extends JavaPlugin {
public JoinExample(JavaPluginInit init) {
super(init)
}
@Override
protected void setup() {
// (1)
Universe.get().getWorlds().keySet().forEach(name -> getEventRegistry().register(PlayerReadyEvent.class, name, this::onPlayerReady));
}
public void onPlayerReady(PlayerReadyEvent event) {
Player player = event.getPlayer();
// (2)
player.sendMessage(PlaceholderAPI.setPlaceholders(player.getPlayerRef(), Message.raw("Welcome %player_name%!")))
}
}
```
1. We tell the server to call `onPlayerReady` whenever a `PlayerReadyEvent` fires.
2. PlaceholderAPI offers multiple `setPlaceholders` methods that can either return a `String` or a `Message` object, depending on your needs.
Note that these methods require input of the same type: `setPlaceholders(PlayerRef, String)` for String and `setPlaceholders(PlayerRef, Message)` for Messages.
///

View File

@@ -22,7 +22,7 @@ When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse)
Some expansions may not be integrated into a plugin or don't even have a plugin to depend on, meaning that they may be their own separate jar file that you have to download.
Such expansions can usually be found on the eCloud of PlaceholderAPI and be downloaded using the [`/papi ecloud download <expansion>`](users/commands.md#papi-ecloud-download) command.
Whether an expansion is available on the eCloud or not can be found out in the [Placeholder List](users/placeholder-list.md) with any expansion displaying a papi command being downlodable.
Whether an expansion is available on the eCloud or not can be found out in the [Placeholder List](users/placeholder-list/index.md) with any expansion displaying a papi command being downlodable.
- ### Plugin actually supports PlaceholderAPI
@@ -37,7 +37,7 @@ When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse)
Double-check that the placeholder you set doesn't contain a typo. You can use [`/papi ecloud placeholders <expansion>`](users/commands.md#papi-ecloud-placeholders) (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.
Additionally can the placeholder list from the eCloud be outdated. It is recommended to check the [Placeholder List](users/placeholder-list.md) or see if there is any documentation for the placeholders you want to use.
Additionally can the placeholder list from the eCloud be outdated. It is recommended to check the [Placeholder List](users/placeholder-list/index.md) or see if there is any documentation for the placeholders you want to use.
- ### Plugin is enabled

View File

@@ -19,7 +19,7 @@ It also has a community-curated list of all available Placeholder expansions and
- [:octicons-chevron-right-16: Commands](users/commands.md)
- [:octicons-chevron-right-16: Using Placeholders](users/using-placeholders.md)
- [:octicons-chevron-right-16: Placeholder List](users/placeholder-list.md)
- [:octicons-chevron-right-16: Placeholder List](users/placeholder-list/index.md)
- [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md)
- ### :material-file-code: Dev Guides
@@ -40,7 +40,8 @@ It also has a community-curated list of all available Placeholder expansions and
Common problems you may face while using PlaceholderAPI, and how to solve them.
- [:octicons-chevron-right-16: Go to Page](common-issues.md)
- [:octicons-chevron-right-16: Common Issues](issues/index.md)
- [:octicons-chevron-right-16: eCloud connection blocked](issues/ecloud-block.md)
- ### :material-chat-question: FAQ

View File

@@ -0,0 +1,74 @@
---
description: Fixing blocked connections to the PlaceholderAPI Expansion Cloud (eCloud).
---
# eCloud connection blocked
If you cannot download expansions via PlaceholderAPI, your server may be unable to reach the PlaceholderAPI Expansion Cloud (eCloud). This is usually caused by a network restriction by your host, firewall, or ISP.
## Symptoms
Common signs include:
- You were directed to this page via an in-game message.
- `/papi ecloud download/update <expansion>` fails (timeouts, errors, connection refused, or similar).
## Why it happens
The download command requires outbound HTTPS access from your server to PlaceholderAPIs eCloud API. Connections can be blocked by:
- Your server hosts firewall / security policy
- A local firewall on the machine
- A network firewall (datacenter, router)
- DNS filtering or an ISP block
## Domains PlaceholderAPI uses
Allow outbound HTTPS (TCP 443) to these domains:
- PlaceholderAPI **< 2.12.0** uses `api.extendedclip.com`
- PlaceholderAPI **>= 2.12.0** uses `*.placeholderapi.com`
## Fix options
### 1) Ask your host to unblock the eCloud
If you use shared hosting or a managed host, you may not be able to change firewall rules yourself. Contact your host and ask them to allow outbound HTTPS requests to the domains listed above.
### 2) Check firewalls / filters you control
If you manage your own server, check any outbound filtering:
- OS firewall rules (Windows Firewall / `ufw` / `iptables`)
- Router/datacenter firewall rules
- DNS filtering
### 3) Manually install expansions (works even if the eCloud is blocked)
If unblocking is not an option, you can download expansions manually:
1. Go to https://ecloud.placeholderapi.com/
2. Open the expansion you want.
3. Download the `.jar`.
4. Put it into your servers `plugins/PlaceholderAPI/expansions/` folder.
5. Run [`/papi reload`](../users/commands.md#papi-reload) (or restart the server).
## Quick connectivity checks (optional)
If you have access to the machine running the server, these checks from a terminal or command prompt can help confirm a block.
```bash
curl -I https://ecloud.placeholderapi.com/api/v3/
curl -I https://api.extendedclip.com/v2/
```
If these commands fail on the server but work on your own PC/network, the server host or datacenter network is most likely blocking outbound connections.
## Still stuck?
If you need help, join the [Discord Server](https://discord.gg/helpchat) and share:
- What you've tried
- The full console error from the download attempt
- The link provided by `/papi dump`

View File

@@ -8,6 +8,12 @@ This page lists common issues you may encounter with PlaceholderAPI and how you
If you have more questions, feel free to join the [Discord Server](https://discord.gg/helpchat).
## eCloud download fails / blocked connection
If your host or network blocks outgoing connections to the Expansion Cloud (eCloud), PlaceholderAPI will be unable to download expansions.
See: [eCloud connection blocked](ecloud-block.md)
## `java.lang.NoClassDefFoundError: com/google/gson/Gson`
If you encounter an issue such as

View File

@@ -30,9 +30,9 @@ The pages listed under this section are meant for server owners who want to use
----
Community-curated list of available PlaceholderExpansions and their placeholders.
Community-curated lists of available Placeholder Expansions and their placeholders for the Minecraft and Hytale versions of PlaceholderAPI.
- [:octicons-chevron-right-16: Go to Page](placeholder-list.md)
- [:octicons-chevron-right-16: Go to Page](placeholder-list/index.md)
- ### Plugins using PlaceholderAPI
@@ -42,4 +42,4 @@ The pages listed under this section are meant for server owners who want to use
- [:octicons-chevron-right-16: Go to Page](plugins-using-placeholderapi.md)
</div>
</div>

View File

@@ -0,0 +1,422 @@
# Hytale
This is a list of all available placeholders for the Hytale version of PlaceholderAPI.
For the Minecraft version, visit [this page](minecraft.md).
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.
Page is only updated on request. We recommend contributing to this list by [making a Pull request](https://github.com/PlaceholderAPI/PlaceholderAPI/pulls).
Further details on how to contribute to this list or the wiki as a whole can be found on the [README file of the Wiki](https://github.com/PlaceholderAPI/PlaceholderAPI/blob/wiki/README.md).
///
- [Standalone](#standalone)
- **A**
- *No Expansions*
- **B**
- *No Expansions*
- **C**
- **[ChangeOutput](#changeoutput)**
- **D**
- *No Expansions*
- **E**
- *No Expansions*
- **F**
- *No Expansions*
- **G**
- *No Expansions*
- **H**
- *No Expansions*
- **I**
- *No Expansions*
- **J**
- *No Expansions*
- **K**
- *No Expansions*
- **L**
- *No Expansions*
- **M**
- *No Expansions*
- **N**
- *No Expansions*
- **O**
- *No Expansions*
- **P**
- **[Player](#player)**
- **Q**
- *No Expansions*
- **R**
- *No Expansions*
- **S**
- **[Server](#server)**
- **T**
- *No Expansions*
- **U**
- *No Expansions*
- **V**
- *No Expansions*
- **W**
- **[World](#world)**
- **X**
- *No Expansions*
- **Y**
- *No Expansions*
- **Z**
- *No Expansions*
----
- [Plugin-placeholders](#plugin-placeholders)
- **A**
- *No Expansions*
- **B**
- *No Expansions*
- **C**
- *No Expansions*
- **D**
- *No Expansions*
- **E**
- **[EliteEssentials](#eliteessentials)**
- **F**
- *No Expansions*
- **G**
- *No Expansions*
- **H**
- **[HyFactions](#hyfactions)**
- **I**
- *No Expansions*
- **J**
- *No Expansions*
- **K**
- *No Expansions*
- **L**
- **[LuckPerms](#luckperms)**
- **M**
- *No Expansions*
- **N**
- *No Expansions*
- **O**
- *No Expansions*
- **P**
- *No Expansions*
- **Q**
- *No Expansions*
- **R**
- *No Expansions*
- **S**
- *No Expansions*
- **T**
- *No Expansions*
- **U**
- *No Expansions*
- **V**
- *No Expansions*
- **W**
- *No Expansions*
- **X**
- *No Expansions*
- **Y**
- *No Expansions*
- **Z**
- *No Expansions*
----
## Standalone
Expansions listed here don't need any plugin/mod 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*.
----
### **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/PlaceholderAPI/Expansion-ChangeOutput/tree/hytale)
```
%changeoutput_<options>_input:<input>_matcher:<matcher>_ifmatch:<output-if-matched>_else:<output-if-not-matched>%
```
- `<options>`
- 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
- `<input>` - this is your text that you wish to replace
- `<match>` - this is the text we will be looking for to meet the conditions
- `<output-if-matched>` - if the input meets the condition, this text will be displayed
- `<output-if-not-matched>` - if the input does not meet the condition, this text will be displayed instead
*All arguments can be replaced with other placeholders, wrapped in* `{}`
----
### **Player**
/// command | papi ecloud download Player
///
```
%player_uuid%
%player_username%
%player_language%
%player_world_uuid%
%player_x%
%player_y%
%player_z%
%player_yaw%
%player_pitch%
%player_has_played_before%
%player_name%
%player_gamemode%
%player_world%
%player_biome%
%player_item_in_hand%
%player_item_in_hand_quantity%
%player_item_in_hand_durability%
%player_item_in_hand_broken%
%player_item_in_hand_unbreakable%
%player_current_fall_distance%
%player_view_radius%
%player_client_view_radius%
%player_since_last_spawn_nanos%
%player_mount_entity_id%
%player_is_collidable%
%player_health%
%player_health_max%
%player_health_min%
%player_ammo%
%player_ammo_max%
%player_ammo_min%
%player_stamina%
%player_stamina_max%
%player_stamina_min%
%player_mana%
%player_mana_max%
%player_mana_min%
%player_oxygen%
%player_oxygen_max%
%player_oxygen_min%
%player_signature_energy%
%player_signature_energy_max%
%player_signature_energy_min%
%player_has_permission_<permission>%
```
----
### **Server**
/// command | papi ecloud download Server
///
```
%server_name%
%server_online%
%server_worlds%
%server_max_players%
%server_max_view_radius%
%server_motd%
%server_default_gamemode%
%server_default_world%
%server_rate_limit_enabled%
%server_rate_limit_packets_per_second%
%server_rate_limit_burst_capacity%
%server_is_booting%
%server_is_shutting_down%
%server_boot_timestamp%
%server_uptime_millis%
%server_uptime_seconds%
%server_uptime%
%server_plugin_count%
```
----
### **World**
/// command | papi ecloud download World
///
```
%world_total%
%world_biome%
%world_time%
%world_timein12%
%world_fulltime%
%world_dayprogress%
%world_moonphase%
%world_sunlightfactor%
%world_date%
%world_sunddirection_x%
%world_sunddirection_y%
%world_sunddirection_z%
%world_name_<world>%
%world_uuid_<world>%
%world_seed_<world>%
%world_canpvp_<world>%
%world_spawnnpc_<world>%
%world_npcfrozen_<world>%
%world_falldamage_<world>%
%world_objectivemarkers_<world>%
%world_entities_<world>%
%world_players_<world>%
%world_players_<world>_<group>%
%world_haspermission_<world>_<permission>%
%world_playerexist_<world>_<playername>%
%world_recentjoin_<world>%
%world_recentquit_<world>%
```
----
## Plugin-placeholders
Expansions listed here require the linked resource (plugin/mod) to work properly.
Most of the listed Expansions are NOT made and maintained by the PlaceholderAPI team.
Please see ?510 for a list of all expansions officially maintained by the PlaceholderAPI team.
### **[EliteEssentials](https://www.curseforge.com/hytale/mods/eliteessentials)**
/// integrated | Built into Plugin
///
```
%eliteessentials_economy_enabled%
%eliteessentials_using_external_economy%
%eliteessentials_currency_name%
%eliteessentials_currency_name_plural%
%eliteessentials_currency_symbol%
%eliteessentials_balance%
%eliteessentials_god%
%eliteessentials_vanished%
%eliteessentials_homes_num%
%eliteessentials_homes_max%
%eliteessentials_homes_names%
%eliteessentials_all_kits_num%
%eliteessentials_all_kits_names%
%eliteessentials_allowed_kits_num%
%eliteessentials_allowed_kits_names%
%eliteessentials_all_warps_num%
%eliteessentials_all_warps_names%
%eliteessentials_allowed_warps_num%
%eliteessentials_allowed_warps_names%
%eliteessentials_home_<name>_name%
%eliteessentials_home_<name>_createdat%
%eliteessentials_home_<name>_coords%
%eliteessentials_home_<name>_x%
%eliteessentials_home_<name>_y%
%eliteessentials_home_<name>_z%
%eliteessentials_home_<name>_yaw%
%eliteessentials_home_<name>_pitch%
%eliteessentials_home_<name>_world%
%eliteessentials_kit_<id>_name%
%eliteessentials_kit_<id>_id%
%eliteessentials_kit_<id>_description%
%eliteessentials_kit_<id>_icon%
%eliteessentials_kit_<id>_cooldown%
%eliteessentials_kit_<id>_remainingcooldown%
%eliteessentials_kit_<id>_items%
%eliteessentials_warp_<name>_name%
%eliteessentials_warp_<name>_description%
%eliteessentials_warp_<name>_permission%
%eliteessentials_warp_<name>_createdat%
%eliteessentials_warp_<name>_createdby%
%eliteessentials_warp_<name>_coords%
%eliteessentials_warp_<name>_x%
%eliteessentials_warp_<name>_y%
%eliteessentials_warp_<name>_z%
%eliteessentials_warp_<name>_yaw%
%eliteessentials_warp_<name>_pitch%
%eliteessentials_warp_<name>_world%
```
----
### **[HyFactions](https://www.curseforge.com/hytale/mods/hyfactions)**
/// command | papi ecloud download HyFactions
///
Relational:
```
%rel_factions_relation% - Relation type (ally, enemy, etc)
%rel_factions_relation_color% - green, white, red
```
Standard:
```
%factions_player_has_faction% - yes/no
%factions_player_faction% - faction name
%factions_player_faction_id% - faction uuid
%factions_player_faction_rank% - rank in faction
%factions_player_power% - power level of player
%factions_party_color% - party color (number)
%factions_party_name% - party name
%factions_party_id% - party id
%factions_party_description% - party description
%factions_party_created% - date of party creation
%factions_party_max_claims% - max number of claims for party
%factions_party_claims% - number of claims by party
%factions_party_members% - number of members in party
%factions_party_owner_id% - owner uuid
%factions_party_owner_name% - owner username
%factions_faction_home_dimension% - dimension name of faction home
%factions_faction_home_x% - 2 D.P. x coord of faction home
%factions_faction_home_y% - 2 D.P. y coord of faction home
%factions_faction_home_z% - 2 D.P. z coord of faction home
%factions_faction_home_coords% - 2 D.P. x y z coords of faction home
%factions_faction_home_yaw% - 2 D.P. yaw of faction home
%factions_faction_home_pitch% - 2 D.P. pitch of faction home
%factions_faction_color% - number of faction color
%factions_faction_description% - faction description
%factions_faction_max_claims% - max claims allowed by faction
%factions_faction_owner_id% - faction owner uuid
%factions_faction_owner_name% - faction owner username
%factions_faction_created% - date of faction creation
%factions_faction_members% - number of members in faction
%factions_faction_relations% - number of relations with other factions
%factions_faction_allies% - number of allies
%factions_faction_neutrals% - number of neutrals
%factions_faction_enemies% - number of enemies
%factions_faction_claims% - number of claims by faction
%factions_faction_total_power% - total power of faction
```
----
### **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
/// command | papi ecloud download LuckPerms
///
```
%luckperms_prefix%
%luckperms_suffix%
%luckperms_meta_<metakey>%
%luckperms_prefix_element_<element>%
%luckperms_suffix_element_<element>%
%luckperms_context_<contextkey>%
%luckperms_groups%
%luckperms_primary_group_name%
%luckperms_has_permission_<permission>%
%luckperms_inherits_permission_<permission>%
%luckperms_check_permission_<permission>%
%luckperms_in_group_<group>%
%luckperms_inherits_group_<group>%
%luckperms_on_track_<track>%
%luckperms_has_groups_on_track_<track>%
%luckperms_highest_group_by_weight%
%luckperms_lowest_group_by_weight%
%luckperms_first_group_on_tracks_<tracks>%
%luckperms_last_group_on_tracks_<tracks>%
%luckperms_expiry_time_<permission>%
%luckperms_inherited_expiry_time_<permission>%
%luckperms_group_expiry_time_<groupname>%
```

View File

@@ -0,0 +1,20 @@
# Placeholder List
PlaceholderAPI is home of countless community-made Placeholder Expansions.
To help you find the expansion you need, we are providing official placeholder lists that include available PlaceholderAPI expansions and their placeholders for both Minecraft (Spigot, Paper, etc.) and Hytale.
<div class="grid cards" markdown>
- ## [Minecraft](minecraft.md)
----
Placeholder list for the Minecraft version of PlaceholderAPI.
- ## [Hytale](hytale.md)
----
Placeholder list for the Hytale version of PlaceholderAPI.
</div>

View File

@@ -2,9 +2,10 @@
description: Community-curated list of available PlaceholderExpansions and their placeholders.
---
# Placeholder List
# Minecraft
This is a list of all available placeholders.
This is a list of all available placeholders for the Minecraft version of PlaceholderAPI.
For the Hytale version, visit [this page](hytale.md).
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.

File diff suppressed because it is too large Load Diff

View File

@@ -39,7 +39,7 @@ This feature exists since version 2.11.4 of PlaceholderAPI
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 [Placeholder List](placeholder-list.md) page for any entry of it.
One way to find out, if an Expansion is included or separate, is to check the [Placeholder List](placeholder-list/index.md) page for any entry of it.
If it exists on the page, can you check the infobox right below the title of the Expansion for one of the following cases:
- `papi ecloud download <expansion>`: The expansion is on the ecloud and needs to be downloaded using the [`/papi ecloud download` command](commands.md#papi-ecloud-download).

View File

@@ -63,6 +63,8 @@ extra:
- reject
- manage
social:
- icon: simple/modrinth
link: https://modrinth.com/plugin/placeholderapi
- icon: fontawesome/regular/paper-plane
link: https://hangar.papermc.io/HelpChat/PlaceholderAPI
- icon: simple/spigotmc
@@ -76,14 +78,19 @@ nav:
- users/index.md
- users/commands.md
- users/using-placeholders.md
- users/placeholder-list.md
- Placeholder List:
- users/placeholder-list/index.md
- users/placeholder-list/minecraft.md
- users/placeholder-list/hytale.md
- users/plugins-using-placeholderapi.md
- Dev Guides:
- developers/index.md
- developers/using-placeholderapi.md
- developers/creating-a-placeholderexpansion.md
- developers/expansion-cloud.md
- common-issues.md
- Common Issues:
- issues/index.md
- issues/ecloud-block.md
- faq.md
- Discord: https://discord.gg/helpchat