Upstream
/
PlaceholderAPI
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add Wiki update action (#373) 

* First step to make automated wiki action

* Add wiki folder and files

* Only trigger on master branch

* Add dump command

* Update Plugins-using-PlaceholderAPI.md

* Create README.md

* Update README.md

* Ignore the readme file

* Update files from wiki

* Update wiki pages
This commit is contained in:
Andre_601 2020-07-28 17:07:41 +02:00 committed by GitHub
parent 5cc65c880a
commit 5047b0cdee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 6419 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
.github/workflows/wiki.yml vendored Normal file
View File

@ -0,0 +1,49 @@
#
# This is a GitHub Action that allows us to auto-update the wiki
# when a Pull request changes specific files in a folder.
#
name: Update Wiki
on:
push:
#
# Only trigger when the push changes any files in the wiki-folder.
#
paths:
- 'wiki/**'
branches:
- 'master'
#
# Releases cause this action to also fire.
# Using this prevents this problem.
#
tags-ignore:
- '**'
jobs:
update:
runs-on: ubuntu-latest
steps:
- name: 'Checkout Code'
uses: actions/Checkout@v2
- name: 'Update Wiki'
uses: docker://decathlon/wiki-page-creator-action:latest
env:
#
# We can use the E-Mail and Name of the GitHub Actions account
# for our convenience.
#
ACTION_MAIL: '41898282+github-actions[bot]@users.noreply.github.com'
ACTION_NAME: 'github-actions[bot]'
GH_PAT: '${{ secrets.GITHUB_TOKEN }}'
OWNER: 'PlaceholderAPI'
REPO_NAME: 'PlaceholderAPI'
#
# We only want to target files in the wiki folder
#
MD_FOLDER: 'wiki'
WIKI_PUSH_MESSAGE: 'Updating wiki from commit ${{ github.event.after }}'
#
# We skip/ignore the README.md file in the Wiki folder
#
SKIP_MD: README.md

239
wiki/Commands.md Normal file
View File

@ -0,0 +1,239 @@
This page shows all commands, including with a detailed description of what every command does.
## Overview
- **[Parse Commands](#parse-commands)**
- [`/papi bcparse <player|me> <string>`](#papi-bcparse)
- [`/papi cmdparse <player|me> <string>`](#papi-cmdparse)
- [`/papi parse <player|me> <string>`](#papi-parse)
- [`/papi parserel <player> <player> <string>`](#papi-parserel)
- **[eCloud Commands](#ecloud-commands)**
- [`/papi ecloud clear`](#papi-ecloud-clear)
- [`/papi ecloud disable`](#papi-ecloud-disable)
- [`/papi ecloud download <expansion> [version]`](#papi-ecloud-download)
- [`/papi ecloud enable`](#papi-ecloud-enable)
- [`/papi ecloud info <expansion> [version]`](#papi-ecloud-info)
- [`/papi ecloud list <all|<author>|installed>`](#papi-ecloud-list)
- [`/papi ecloud placeholders <expansion>`](#papi-ecloud-placeholders)
- [`/papi ecloud refresh`](#papi-ecloud-refresh)
- [`/papi ecloud status`](#papi-ecloud-status)
- **[Expansion Commands](#expansion-commands)**
- [`/papi info <expansion>`](#papi-info)
- [`/papi list`](#papi-list)
- [`/papi register <jar file>`](#papi-register)
- [`/papi unregister <jar file>`](#papi-unregister)
- **[Other Commands](#other-commands)**
- [`/papi dump`](#papi-dump)
- [`/papi reload`](#papi-reload)
----
### Parse Commands
These commands are used to parse placeholders into their respective values. Useful for debugging.
#### `/papi bcparse`
**Description**:
Parses placeholders of a String and broadcasts the result to all players.
**Arguments**:
* `<player|me>` - The Player to parse values of the placeholder (Use `me` for yourself).
* `<Text with placeholders>` - The text to parse.
**Example**:
```
/papi bcparse funnycube My name is %player_name%!
```
----
#### `/papi cmdparse`
**Description**:
Parses placeholders of a String and executes it as a command.
**Arguments**:
- `<player|me>` - The player to parse placeholders against. Use `me` for yourself.
- `<Command with placeholders>` - The Text to parse and execute as command. Please leave away the `/` of the command.
**Example**:
```
/papi cmdparse funnycube say My name is %player_name%!
```
----
#### `/papi parse`
**Description**:
Parses the placeholders in a given text and shows the result.
**Arguments**:
* `<player|me>` - The Player to parse values of the placeholder (Use `me` for yourself).
* `<Text with placeholders>` - The text to parse.
**Example**:
```
/papi parse funnycube My group is %vault_group%
```
----
#### `/papi parserel`
**Description**:
Parses a relational placeholder.
**Arguments**:
* `<player1>` - The first player.
* `<player2>` - the second player to compare with.
* `<Text with placeholders>` - The actual placeholder to parse.
**Example**:
```
/papi parserel funnycube extended_clip %placeholder%
```
----
### eCloud Commands
These commands all start with `/papi ecloud` and are used for things related about the [[Expansion Cloud]].
#### `/papi ecloud clear`
**Description**:
Clears the cache for the eCloud.
----
#### `/papi ecloud disable`
**Description**:
Disables the connection to the eCloud.
----
#### `/papi ecloud download`
**Description**:
Allows you to download an expansion from the eCloud
**Arguments**:
- `<expansion>` - The expansion to download.
- `[version]` - The specific version of the expansion to download (Optional)
**Example**:
```
/papi ecloud download Vault
/papi ecloud download Vault 1.5.2
```
----
#### `/papi ecloud enable`
**Description**:
Enables the connection to the eCloud
----
#### `/papi ecloud info`
**Description**:
Gives information about a specific Expansion.
**Arguments**:
- `<expansion>` - The Expansion to retrieve information from.
- `[version]` - The Expansion's version to get information from.
**Example**:
```
/papi ecloud info Vault
```
----
#### `/papi ecloud list`
**Description**:
Lists either all Expansions on the eCloud, only those by a specific author or only those that you have [installed](#papi-ecloud-download).
Installed Expansions show as green in the list and Expansions that are installed and have an update available show as gold.
**Arguments**:
- `<all|<author>|installed>` - List all Expansions, Expansions of a specific author or all Expnansions you have installed.
**Example**:
```
/papi ecloud list all
/papi ecloud list clip
/papi ecloud list installed
```
----
#### `/papi ecloud placeholders`
**Description**:
List all placeholders of an Expansion.
**Arguments**:
- `<expansion>` - The Expansion to list placeholders of.
**Example**:
```
/papi ecloud placeholders Vault
```
----
#### `/papi ecloud refresh`
**Description**:
Refresh the cached data from the eCloud.
----
#### `/papi ecloud status`
**Description**:
Displays the actual Status of the eCloud.
----
### Expansion Commands
These commands can be used to manage the expansions that you have currently installed.
#### `/papi info`
**Description**:
Gives you information about the specified Expansion.
**Argument(s)**:
- `<expansion>` - The Expansion to get info from (Needs to be registered and active).
**Example**:
```
/papi info Vault
```
----
#### `/papi list`
**Description**:
Lists all active/registered expansions.
This is different to [/papi ecloud list installed](#papi-ecloud-list) in the fact, that it also includes expansions that were installed through a plugin (That aren't a separate jar-file) and it also doesn't show which one have updates available.
----
#### `/papi register`
**Description**:
Registers an expansion from a specified filename.
This is useful in cases, where you downloaded the expansion manually and don't want to restart the server.
The file needs to be inside `/plugins/PlaceholderAPI/expansions`.
**Arguments**:
- `<filename>` - The file to register (including the file-extension).
**Example**:
```
/papi register MyExpansion.jar
```
----
#### `/papi unregister`
**Description**:
Unregisters the specified expansion.
**Arguments**:
- `<filename>` - The expansion to unregister.
**Example**:
```
/papi unregister MyExpansion.jar
```
----
### Other Commands
These are other commands of PlaceholderAPI that don't fit any of the above categories.
#### `/papi dump`
**Description**:
Pastes useful information from PlaceholderAPI such as plugin version, server version and installed expansions to https://paste.helpch.at for simple sharing and support.
#### `/papi reload`
**Description**:
Reloads the config settings.
You need to use this command after [downloading Expansions](#papi-ecloud-download) from the eCloud or they won't be properly registered.

67
wiki/Expansion-cloud.md Normal file
View File

@ -0,0 +1,67 @@
## About
PlaceholderAPI uses an expansion-cloud (A website that has all kinds of expansions stored), to download jar-files, that contain the placeholders for it to use.
The expansion-cloud can be seen under https://api.extendedclip.com/home
## How it works
PlaceholderAPI connects to the ecloud on startup of your server, to check if the cloud is available and how many expansions are available on it.
If you run `/papi ecloud download <expansion>` PlaceholderAPI will connect to the site to first check if the specified expansion exists and then downloads it if it does.
Note that not all listed expansions are on the ecloud. Some are in the corresponding plugin itself and are registered on the startup of the server.
You can disable the connection to the cloud by setting `cloud_enabled` in the config.yml to false.
## Adding your own expansion
You can add your own expansion to the expansion-cloud for others to use.
In order to do that, you have to follow those steps:
1. Make sure you have created a seperate jar-file like explained on the page [[PlaceholderExpansion]].
2. Create an account on the site, or log in, if you already have one.
3. Click on `Expansions` and then on [`Upload New`](https://api.extendedclip.com/manage/add/).
4. Fill out the required information. `Source URL` and `Dependency URL` are optional.
5. Click on the button that says `Choose an file...` and select the jar of your expansion.
* **Important**! Make sure, that the name of the jar-file contains the same version like you set in the version-field!
6. Click on `Submit Expansion`
Your expansion is now uploaded and will be reviewed by a moderator.
If everything is ok will your expansion be approved and will be available on the ecloud for PlaceholderAPI*.
> *You can only download verified Expansions through PlaceholderAPIs command, unless you enable the option `cloud_allow_unverified_expansions` in the config.yml
> Unverified expansions can be downloaded manually by going to the site and download it yourself.
## Updating your expansion
Before you update, please note the following:
If you aren't a verified dev and you upload an update, your expansion will become **unverified** until a moderator reviews the update and approves it!
It is recommended to only update the expansion, if it contains huge changes or bug fixes.
To update your expansion, you first have to go to the list of [your expansions](https://api.extendedclip.com/manage/).
For that click on `Expansions` and select `Your Expansions`.
After that, follow those steps:
1. Click the name of the expansion, that you want to update.
2. Click on the button that says `Version`
3. Click on `Add Version`
4. Fill out the fields and upload the new jar.
* **Important**! Make sure, that the name of the jar-file contains the same version like you set in the version-field!
5. Click on `Save Changes`
If you're a verified dev, your version will be approved and is available directly.
If you aren't a verified dev, you have to wait until a moderator approves the update.
## Downloading a specific expansion version
In some cases, you may want to use a specific, older version of expansion. Such a case could be for example, when you run an old server version and the newest version of an expansion uses methods that aren't available on that particular server version.
For that case is there a way, to download a specific version of expansion. You can download the expansion either manually, or through PlaceholderAPI itself.
Here is how you can do it for each.
### Download with PlaceholderAPI
This is the easiest of both methods since it requires the least amount of effort.
Run the following command in-game or in your console to download a specific version:
`/papi ecloud download <expansion> [version]`
To find out, what versions are available for the expansion, run `/papi ecloud info <expansion>`
You can then run `/papi ecloud versioninfo <expansion> <version>` to receive more infor about a specific version.
After you downloaded the specific version, run `/papi reload` to refresh the installed expansions.
### Download manually
To download an expansion manually, you first have to connect to the website and go to the expansion of your choice.
There, you click on the button that says `Version` and click on the download-icon of the version you want to download.
Finally, stop your server, upload the jar to the folder in `/plugins/PlaceholderAPI/expansions` (Make sure to delete the old jar, if there's already one) and start the server again.

22
wiki/FAQ.md Normal file
View File

@ -0,0 +1,22 @@
Here are frequently asked questions about stuff related to PlaceholderAPI.
## It only shows %placeholder% and not the variable
Make sure, that you've tried the following steps:
- PlaceholderAPI is installed and running (Shows green in `/pl` and responds to the `/papi` command)
- You downloaded the expansion with `/papi ecloud download [expansion]`
A list of available expansions and their placeholders can be found [[here|Placeholders]]!
Also note that not all placeholders are in a seperate expansion. Some are "hardcoded" into a plugin.
- You reloaded PlaceholderAPI with `/papi reload` after downloading an expansion.
- Any possible dependency for the expansion (Plugin) is installed and running.
- The placeholder doesn't contain any typos.
- The plugin that should use the placeholder actually supports PlaceholderAPI.
For a list of plugins supporting PlaceholderAPI go [[here|Plugins-using-PlaceholderAPI]].
## I can't download the expansion
Make sure, that the connection to the cloud (https://api.extendedclip.com) isn't blocked by a firewall or similar.
Next step would be to check if the expansion actually exists on the cloud. Not all plugins provide their placeholders through a separate jar on the cloud. Some have them build in and register them on startup.
If both checks failed, go to the cloud-page and download the jar manually. Put it then in the `expansions` folder of PlaceholderAPI (`/plugins/PlaceholderAPI/expansions`)
## How can other plugins use my placeholders with PlaceholderAPI?
A tutorial can be found [[here|Hook into PlaceholderAPI]]!

76
wiki/Home.md Normal file
View File

@ -0,0 +1,76 @@
<p align="center">
<img src="https://i.imgur.com/puadJ8Z.png" alt="PlaceholderAPI">
</p>
This wiki gives you information on how to create placeholders in your plugin that can be used in other plugins, how to use other placeholders inside your plugin, or how to make an expansion.
It also has a list with all available placeholders (Work in progress).
### Setup
**[[Hook into PlaceholderAPI]]**
* [[First steps|Hook-into-PlaceholderAPI#first-steps]]
* [[Adding placeholders to PlaceholderAPI|Hook-into-PlaceholderAPI#adding-placeholders-to-placeholderapi]]
* [[PlaceholderExpansion]]
* [[Without an external plugin|PlaceholderExpansion#without-an-external-plugin]]
* [[With external plugin|PlaceholderExpansion#with-external-plugin]]
* [[Setting placeholders in your plugin|Hook-into-PlaceholderAPI#setting-placeholders-in-your-plugin]]
### Other
**[[Commands]]**
**[[Expansion cloud]]**
**[[FAQ]]**
**[[Plugins using PlaceholderAPI]]**
**[[Placeholders|Placeholders]]**
(Click the arrows to expand)
<details>
<summary> [[PAPI-placeholders|Placeholders#papi-placeholders-1]] </summary>
- [[Advancements|Placeholders#advancements]]
- [[BungeeCord|Placeholders#bungeecord]]
- [[CooldownBar|Placeholders#cooldownbar]]
- [[CheckItem|Placeholders#checkitem]]
- [[Javascript|Placeholders#javascript]]
- [[ListPlayers|Placeholders#listplayer]]
- [[Math|Placeholders#math]]
- [[MVdW placeholders|Placeholders#mvdw-placeholders]]
- [[OtherPlayer|Placeholders#otherplayer]]
- [[Pinger|Placeholders#pinger]]
- [[Player|Placeholders#player]]
- [[Plugin|Placeholders#plugin]]
- [[Progress|Placeholders#progress]]
- [[RainbowColor|Placeholders#rainbowcolor]]
- [[RandomColor|Placeholders#randomcolor]]
- [[RedisBungee|Placeholders#redisbungee]]
- [[RelCon|Placeholders#relcon]]
- [[ScoreboardObjectives|Placeholders#scoreboardobjectives]]
- [[Server|Placeholders#server]]
- [[Sound|Placeholders#sound]]
- [[Spectators|Placeholders#spectators]]
- [[Statistic|Placeholders#statistic]]
</details>
<details>
<summary> [[Plugin-placeholders|Placeholders#plugin-placeholders-1]] </summary>
- [[A|Placeholders#a]]
- [[B|Placeholders#b]]
- [[C|Placeholders#c]]
- [[D|Placeholders#d]]
- [[E|Placeholders#e]]
- [[F|Placeholders#f]]
- [[G|Placeholders#g]]
- [[H|Placeholders#h]]
- [[I|Placeholders#i]]
- [[J|Placeholders#j]]
- [[K|Placeholders#k]]
- [[L|Placeholders#l]]
- [[M|Placeholders#m]]
- [[N|Placeholders#n]]
- [[O|Placeholders#o]]
- [[P|Placeholders#p]]
- [[Q|Placeholders#q]]
- [[R|Placeholders#r]]
- [[S|Placeholders#s]]
- [[T|Placeholders#t]]
- [[U|Placeholders#u]]
- [[V|Placeholders#v]]
- [[W|Placeholders#w]]
- [[Z|Placeholders#z]]
</details>

137
wiki/Hook-into-PlaceholderAPI.md Normal file
View File

@ -0,0 +1,137 @@
[APIBadge]: https://img.shields.io/nexus/r/http/repo.extendedclip.com/me.clip/placeholderapi.svg?label=API-Version
[SpigotBadge]: https://img.shields.io/spiget/version/6245?label=Spigot
[Spigot]: https://spigotmc.org/resources/6245
[GitHubBadge]: https://img.shields.io/github/v/release/PlaceholderAPI/PlaceholderAPI?label=GitHub%20Release
[GitHub]: /PlaceholderAPI/PlaceholderAPI/releases/latest
> [![SpigotBadge]][Spigot] [![GitHubBadge]][GitHub]
>
> ![APIBadge]
>
> *The GitHub release may be different from the spigot release*
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**!
## First steps
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
### Import with Maven
To import PlaceholderAPI, simply add the following code to your **pom.xml**
Replace `{VERSION}` with the version listed at the top of this page.
```xml
<repositories>
<repository>
<id>placeholderapi</id>
<url>https://repo.extendedclip.com/content/repositories/placeholderapi/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId>
<version>{VERSION}</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
### Import with Gradle
Here is how you can import PlaceholderAPI through gradle.
Put this into your **Gradle.build**.
Replace `{VERSION}` with the version listed at the top of this page.
```gradle
repositories {
maven {
url = 'https://repo.extendedclip.com/content/repositories/placeholderapi/'
}
}
dependencies {
compileOnly 'me.clip:placeholderapi:{VERSION}'
}
```
### Set PlaceholderAPI as (soft)depend
Next step is to go to your plugin.yml and add PlaceholderAPI as a depend or softdepend, depending (no pun intended) on if it is optional or not.
**Example Softdepend**:
```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.here
softdepend: [PlaceholderAPI] # This is used, if your plugin works without PlaceholderAPI.
```
**Example Depend**:
```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.here
depend: [PlaceholderAPI] # If your plugin requires PlaceholderAPI, to work, use this.
```
## Adding placeholders to PlaceholderAPI
A full guide on how to create expansions can be found on the [[PlaceholderExpansion]] page of this wiki.
## 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.
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**:
Let's assume we want to send an own join message that shows the group a player has.
To achieve that, we can do the following:
```java
package at.helpch.placeholderapi;
import me.clip.placeholderapi.PlaceholderAPI;
import org.bukkit.Bukkit;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;
import me.clip.placeholderapi.PlaceholderAPI;
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);
} else {
throw new RuntimeException("Could not find PlaceholderAPI!! Plugin can not work without it!");
}
}
@EventHandler(priority = EventPriority.HIGHEST)
public void onJoin(PlayerJoinEvent event) {
String joinText = "%player_name% &ajoined the server! He/she is rank &f%vault_rank%";
/*
* We parse the placeholders using "setPlaceholders"
* This would turn %vault_rank% into the name of the Group, that the
* joining player has.
*/
joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText);
event.setJoinMessage(withPlaceholdersSet);
}
}
```

411
wiki/PlaceholderExpansion.md Normal file
View File

@ -0,0 +1,411 @@
## Overview
This page covers how you can use the `PlaceholderExpansion` to add own placeholders to PlaceholderAPI, which then can be used by other plugins.
PlaceholderAPI is using Expansions for its placeholders, with PlaceholderAPI providing the core. Users can download Expansions from the cloud server using commands in-game or by going [here](https://api.extendedclip.com/home/) if they want to use the placeholder.
## Note
You can either make a separate jar file, to upload it to the expansion-cloud (recommended) or have it as a local class inside your plugin.
## Examples
There are multiple methods and ways you can use the PlaceholderExpansion.
Those depend on what you want to display through the placeholders in the end.
* [Without external plugin](#without-external-plugin)
* [With external plugin](#with-external-plugin)
* [Separate jar](#separate-jar)
* [Internal class](#internal-class)
### Without an external plugin
This part here covers how you create an expansion that doesn't require any external/additional plugins to function.
Examples of such expansions are:
- [Player expansion](/PlaceholderAPI/Player-Expansion)
- [Math expansion](https://github.com/Andre601/Math-Expansion)
- [Statistics expansion](/PlaceholderAPI/Statistics-Expansion)
Since it would be weird (and also make no real sense) to have this inside your plugin, we assume you make a separate jar-file as an expansion.
To begin, first make the class extend the `PlaceholderExpansion` and add the required methods:
```java
package at.helpch.placeholderapi.example.expansions;
import org.bukkit.OfflinePlayer;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
/**
* This class will automatically register as a placeholder expansion
* when a jar including this class is added to the directory
* {@code /plugins/PlaceholderAPI/expansions} on your server.
* <br>
* <br>If you create such a class inside your own plugin, you have to
* register it manually in your plugins {@code onEnable()} by using
* {@code new YourExpansionClass().register();}
*/
public class SomeExpansion extends PlaceholderExpansion {
/**
* This method should always return true unless we
* have a dependency we need to make sure is on the server
* for our placeholders to work!
*
* @return always true since we do not have any dependencies.
*/
@Override
public boolean canRegister(){
return true;
}
/**
* The name of the person who created this expansion should go here.
*
* @return The name of the author as a String.
*/
@Override
public String getAuthor(){
return "someauthor";
}
/**
* The placeholder identifier should go here.
* <br>This is what tells PlaceholderAPI to call our onRequest
* method to obtain a value if a placeholder starts with our
* identifier.
* <br>This must be unique and can not contain % or _
*
* @return The identifier in {@code %<identifier>_<value>%} as String.
*/
@Override
public String getIdentifier(){
return "example";
}
/**
* This is the version of this expansion.
* <br>You don't have to use numbers, since it is set as a String.
*
* @return The version as a String.
*/
@Override
public String getVersion(){
return "1.0.0";
}
/**
* This is the method called when a placeholder with our identifier
* is found and needs a value.
* <br>We specify the value identifier in this method.
* <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
*
* @param player
* A {@link org.bukkit.OfflinePlayer OfflinePlayer}.
* @param identifier
* A String containing the identifier/value.
*
* @return Possibly-null String of the requested identifier.
*/
@Override
public String onRequest(OfflinePlayer player, String identifier){
// %example_placeholder1%
if(identifier.equals("placeholder1")){
return "placeholder1 works";
}
// %example_placeholder2%
if(identifier.equals("placeholder2")){
return "placeholder2 works";
}
// We return null if an invalid placeholder (f.e. %example_placeholder3%)
// was provided
return null;
}
}
```
----
### With external plugin
Those examples here applies to people who want to provide information from their own plugin through placeholders from PlaceholderAPI.
There exists a repository showcasing an [example-expansion](/PlaceholderAPI/Example-Expansion) with what you can/should do.
In our examples do we have the plugin `SomePlugin` and want to show certain placeholders with it.
There are two ways to actually get information from your plugin and they only are different in if you have the expansion as a separate jar-file or as an internal class.
#### Separate jar
In our separate jar do we have to make some checks, to be sure, that the required plugin is installed and running.
The below code shows how the class can look like in case the plugin doesn't have a public and easy to access API.
```java
package at.helpch.placeholderapi.example.expansions;
import org.bukkit.OfflinePlayer;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import at.helpch.placeholderapi.example.SomePlugin;
/**
* This class will automatically register as a placeholder expansion
* when a jar including this class is added to the directory
* {@code /plugins/PlaceholderAPI/expansions} on your server.
* <br>
* <br>If you create such a class inside your own plugin, you have to
* register it manually in your plugins {@code onEbale()} by using
* {@code new YourExpansionClass().register();}
*/
public class SomeExpansion extends PlaceholderExpansion {
// We get an instance of the plugin later.
private SomePlugin plugin;
/**
* Since this expansion requires api access to the plugin "SomePlugin"
* we must check if said plugin is on the server or not.
*
* @return true or false depending on if the required plugin is installed.
*/
@Override
public boolean canRegister(){
return (plugin = (SomePlugin) Bukkit.getPluginManager().getPlugin(getRequiredPlugin())) != null;
}
/**
* The name of the person who created this expansion should go here.
*
* @return The name of the author as a String.
*/
@Override
public String getAuthor(){
return "someauthor";
}
/**
* The placeholder identifier should go here.
* <br>This is what tells PlaceholderAPI to call our onRequest
* method to obtain a value if a placeholder starts with our
* identifier.
* <br>This must be unique and can not contain % or _
*
* @return The identifier in {@code %<identifier>_<value>%} as String.
*/
@Override
public String getIdentifier(){
return "someplugin";
}
/**
* if the expansion requires another plugin as a dependency, the
* proper name of the dependency should go here.
* <br>Set this to {@code null} if your placeholders do not require
* another plugin to be installed on the server for them to work.
* <br>
* <br>This is extremely important to set your plugin here, since if
* you don't do it, your expansion will throw errors.
*
* @return The name of our dependency.
*/
@Override
public String getRequiredPlugin(){
return "SomePlugin";
}
/**
* This is the version of this expansion.
* <br>You don't have to use numbers, since it is set as a String.
*
* @return The version as a String.
*/
@Override
public String getVersion(){
return "1.0.0";
}
/**
* This is the method called when a placeholder with our identifier
* is found and needs a value.
* <br>We specify the value identifier in this method.
* <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
*
* @param player
* A {@link org.bukkit.Player Player}.
* @param identifier
* A String containing the identifier/value.
*
* @return possibly-null String of the requested identifier.
*/
@Override
public String onPlaceholderRequest(Player player, String identifier){
if(p == null){
return "";
}
// %someplugin_placeholder1%
if(identifier.equals("placeholder1")){
return plugin.getConfig().getString("placeholder1", "value doesnt exist");
}
// %someplugin_placeholder2%
if(identifier.equals("placeholder2")){
return plugin.getConfig().getString("placeholder2", "value doesnt exist");
}
// We return null if an invalid placeholder (f.e. %someplugin_placeholder3%)
// was provided
return null;
}
}
```
----
#### Internal class
You can have the class inside your plugin.
This has some advantages but can also have some disadvantages.
If you include a PlaceholderExpansion class in your plugin, you MUST add an override the persist() method to return true
otherwise, if PlaceholderAPI is reloaded, your expansion will be unregistered and lost forever.
```java
package at.helpch.placeholderapi.example.expansions;
import org.bukkit.OfflinePlayer;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import at.helpch.placeholderapi.example.SomePlugin;
/**
* This class will be registered through the register-method in the
* plugins onEnable-method.
*/
public class SomeExpansion extends PlaceholderExpansion {
private SomePlugin plugin;
/**
* Since we register the expansion inside our own plugin, we
* can simply use this method here to get an instance of our
* plugin.
*
* @param plugin
* The instance of our plugin.
*/
public SomeExpansion(SomePlugin plugin){
this.plugin = plugin;
}
/**
* Because this is an internal class,
* you must override this method to let PlaceholderAPI know to not unregister your expansion class when
* PlaceholderAPI is reloaded
*
* @return true to persist through reloads
*/
@Override
public boolean persist(){
return true;
}
/**
* Because this is a internal class, this check is not needed
* and we can simply return {@code true}
*
* @return Always true since it's an internal class.
*/
@Override
public boolean canRegister(){
return true;
}
/**
* The name of the person who created this expansion should go here.
* <br>For convienience do we return the author from the plugin.yml
*
* @return The name of the author as a String.
*/
@Override
public String getAuthor(){
return plugin.getDescription().getAuthors().toString();
}
/**
* The placeholder identifier should go here.
* <br>This is what tells PlaceholderAPI to call our onRequest
* method to obtain a value if a placeholder starts with our
* identifier.
* <br>This must be unique and can not contain % or _
*
* @return The identifier in {@code %<identifier>_<value>%} as String.
*/
@Override
public String getIdentifier(){
return "someplugin";
}
/**
* This is the version of the expansion.
* <br>You don't have to use numbers, since it is set as a String.
*
* For convienience do we return the version from the plugin.yml
*
* @return The version as a String.
*/
@Override
public String getVersion(){
return plugin.getDescription().getVersion();
}
/**
* This is the method called when a placeholder with our identifier
* is found and needs a value.
* <br>We specify the value identifier in this method.
* <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
*
* @param player
* A {@link org.bukkit.Player Player}.
* @param identifier
* A String containing the identifier/value.
*
* @return possibly-null String of the requested identifier.
*/
@Override
public String onPlaceholderRequest(Player player, String identifier){
if(player == null){
return "";
}
// %someplugin_placeholder1%
if(identifier.equals("placeholder1")){
return plugin.getConfig().getString("placeholder1", "value doesnt exist");
}
// %someplugin_placeholder2%
if(identifier.equals("placeholder2")){
return plugin.getConfig().getString("placeholder2", "value doesnt exist");
}
// We return null if an invalid placeholder (f.e. %someplugin_placeholder3%)
// was provided
return null;
}
}
```
As you can see is this method pretty similar to the one without any external plugins, since we can get an instance of our plugin much easier and also have a 100% guarantee that the plugin is installed and running.
Our final step now is to register the class and its placeholders. The plugin doesn't do this on its own.
To achieve this, add the following to your `onEnable()` section (Use your expansion name of course):
```java
package at.helpch.placeholderapi.example
import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin;
public class SomePlugin extends JavaPlugin{
@Override
public void onEnable(){
// Small check to make sure that PlaceholderAPI is installed
if(Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null){
new SomeExpansion(this).register();
}
}
}
```

4300
wiki/Placeholders.md Normal file
View File

File diff suppressed because it is too large Load Diff

944
wiki/Plugins-using-PlaceholderAPI.md Normal file
View File

@ -0,0 +1,944 @@
This here is a list of all plugins supporting PlaceholderAPI by either having their own placeholders added, or just allowing other placeholders to be used.
If your plugin isn't shown here and you want it to be added, [open an issue](/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md) and we will add it!
## Plugins
* **[A](#a)**
* **[B](#b)**
* **[C](#c)**
* **[D](#d)**
* **[E](#e)**
* **[F](#f)**
* **[G](#g)**
* **[H](#h)**
* **[I](#i)**
* **[J](#j)**
* **[K](#k)**
* **[L](#l)**
* **[M](#m)**
* **[N](#n)**
* **[O](#o)**
* **[P](#p)**
* **[Q](#q)**
* **[R](#r)**
* **[S](#s)**
* **[T](#t)**
* **[U](#u)**
* **[V](#v)**
* **[W](#w)**
* **[X](#X)**
----
## A
- **[AAC - AdvancedAntiCheat](https://www.spigotmc.org/resources/6442/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#aac]]**]
- **[AbstractMenus](https://www.spigotmc.org/resources/75107/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#abstractmenus]]**]
- **[AcidIsland](https://www.spigotmc.org/resources/581/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#acidisland]]**]
- **[Advanced Abilities](https://www.spigotmc.org/resources/21983/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#advanced-abilities]]**]
- **[Advanced Achievements](https://www.spigotmc.org/resources/6239/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[AdvancedAFK](https://www.spigotmc.org/resources/60761/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#advancedafk]]**]
- **[AdvancedCustomMenu+](https://www.spigotmc.org/resources/47945/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#advancedcustommenu]]**]
- **[AdvancedLottery](https://www.spigotmc.org/resources/43668/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#advancedlottery]]**]
- **[AdvancedModReq](https://www.spigotmc.org/resources/40528/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#advancedmodreq]]**]
- **[Advance Tab](https://www.spigotmc.org/resources/21958/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ajParkour](https://www.spigotmc.org/resources/60909/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ajparkour]]**]
- **[AnimatedBoard](https://www.spigotmc.org/resources/13632/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[AnimatedScoreboard](https://www.spigotmc.org/resources/20848/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Animated Menu](https://www.spigotmc.org/resources/4690/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#amimated-menu]]**]
- **[AnimatedSpecialBar](https://www.spigotmc.org/resources/24654/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[AnnouncementsEverywhere](https://www.spigotmc.org/resources/59510/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[AParkour](https://www.spigotmc.org/resources/30923/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#aparkour]]**]
- **[ASkyBlock](https://www.spigotmc.org/resources/1220/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#askyblock]]**]
- **[AsyncKeepAlive](https://www.spigotmc.org/resources/64676/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#asynckeepalive]]**]
- **[AutoCommandsPlus](https://www.spigotmc.org/resources/11083/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[AutoRank](https://www.spigotmc.org/resources/3239/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#autorank]]**]
- **[AutoSell](https://www.spigotmc.org/resources/2157/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#autosell]]**]
----
## B
- **[BankSystem](https://www.spigotmc.org/resources/61580/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#banksystem]]**]
- **[BannerBoard](https://www.spigotmc.org/resources/20435/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[BattleLevels](https://www.spigotmc.org/resources/2218/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#battlelevels]]**]
- **[BeautyQuests](https://www.spigotmc.org/resources/39255/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#beautyquests]]**]
- **[BedWars1058](https://www.spigotmc.org/resources/50942/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#bedwars1058]]**]
- **[BentoBox](https://github.com/BentoBoxWorld/BentoBox)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#bentobox]]**]
- **[Big Doors Opener](https://www.spigotmc.org/resources/80805/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[BlockParty](https://www.spigotmc.org/resources/7264/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#blockparty]]**]
- **[BlockQuests](https://www.spigotmc.org/resources/32729/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#blockquests]]**]
- **[BookStats](https://www.spigotmc.org/resources/4313/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[BossBarSet](https://www.spigotmc.org/resources/26963/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[BossVote](https://www.spigotmc.org/resources/16497/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Broadcaster Plugin](https://dev.bukkit.org/projects/broadcaster-plugin)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[BuildBattlePro](https://www.spigotmc.org/resources/49587/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#buildbattlepro]]**]
- **[BungeePerms](https://www.spigotmc.org/resources/25/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#bungeeperms]]**]
----
## C
- **[CarlTheCreeper](https://www.spigotmc.org/resources/18008/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#carlthecreeper]]**]
- **[Characters Premium](https://www.spigotmc.org/resources/45142/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ChatBot](https://www.spigotmc.org/resources/55642/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ChatColor+](https://www.spigotmc.org/resources/1546/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#chatcolor]]**]
- **[ChatColor+ Premium](https://www.spigotmc.org/resources/54093/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#chatcolor-premium]]**]
- **[ChatControl Pro](https://www.spigotmc.org/resources/10258/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Chat Format](https://www.spigotmc.org/resources/11780/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [**[[Link|Placeholders#chat-format]]**]
- **[ChatManager](https://www.spigotmc.org/resources/52245/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ChatReaction](https://www.spigotmc.org/resources/3748/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#chatreaction]]**]
- **[CheckNameHistory](https://www.spigotmc.org/resources/3768/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#checknamehistory]]**]
- **[ChestCommands](https://dev.bukkit.org/projects/chest-commands)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CitizensBooks](https://www.spigotmc.org/resources/37465/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [**[[Link|Placeholders#citizensbooks]]**]
- **[Clans-API for Spigot/Clan tag in chat](https://www.spigotmc.org/resources/31547/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#clans-api-for-spigotclan-tag-in-chat]]**]
- **[Clans](https://www.spigotmc.org/resources/34696/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#clans]]**]
- **[Clans](https://www.spigotmc.org/resources/78415/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#clans-1]]**]
- **[ClicksPerSecond](https://www.spigotmc.org/resources/57214/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CMI](https://www.spigotmc.org/resources/3742/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CombatLogX](https://www.spigotmc.org/resources/31689/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#combatlogx]]**]
- **[CommandConditions](https://www.spigotmc.org/resources/41736/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Compassance](https://www.spigotmc.org/resources/18327/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#compassance]]**]
- **[Country on Join](https://www.spigotmc.org/resources/34275/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#country-on-join]]**]
- **[CraftConomy](https://www.spigotmc.org/resources/2395/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#craftconomy]]**]
- **[CraftingStore.net](https://www.spigotmc.org/resources/31331/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#craftingstorenet]]**]
- **[CTSNC](https://www.spigotmc.org/resources/10714/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CursedVIP](https://www.spigotmc.org/resources/67068/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#cursedvip]]**]
- **[CustomCommands](https://www.spigotmc.org/resources/14363/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CustomGUI (Free)](https://www.spigotmc.org/resources/58440/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CustomGUI (Paid)](https://www.spigotmc.org/resources/7386/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CustomHelp](https://www.spigotmc.org/resources/20606/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[CustomSigns](https://www.spigotmc.org/resources/63569/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
----
## D
- **[Daily Rewards](https://www.spigotmc.org/resources/16708)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#daily-rewards]]**]
- **[DeliveryMan](https://www.spigotmc.org/resources/14131/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#deliveryman]]**]
- **[DeluxeChat](https://www.spigotmc.org/resources/1277/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#deluxechat]]**]
- **[DeluxeCombat](https://www.spigotmc.org/resources/63970/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#deluxecombat]]**]
- **[DeluxeCommands](https://www.spigotmc.org/resources/8033/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[DeluxeMenus](https://www.spigotmc.org/resources/11734/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[DeluxeTags](https://www.spigotmc.org/resources/4390/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#deluxetags]]**]
- **[Depinezen](/DenizenScript/Depenizen-For-Bukkit/blob/master/README.md) (For [Denizen](https://www.spigotmc.org/resources/21039/))**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#denizen]]**]
- **[DiscordSRV](https://www.spigotmc.org/resources/18494/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#discordsrv]]**]
- **[Disease](https://www.spigotmc.org/resources/3911/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#disease]]**]
- **DonationParty**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#donationparty]]**]
- **[Donations Holograms](https://www.spigotmc.org/resources/1956/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#donations-holograms]]**]
- **[DragonSlayer](https://www.spigotmc.org/resources/36250/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#dragonslayer]]**]
- **[DungeonsXL](https://www.spigotmc.org/resources/9488/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#dungeonsxl]]**]
----
## E
- **[Economy Bank](https://www.spigotmc.org/resources/7674/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#economy-bank]]**]
- **[Enjin & DonationCraft 2.x](https://dev.bukkit.org/projects/emp)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#enjin--donationcraft-2x]]**]
- **[Enhanced BalTop](https://www.spigotmc.org/resources/20168/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Envoys](https://www.spigotmc.org/resources/20357/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#envoys]]**]
- **[EpicCraftingsPlus](https://www.spigotmc.org/resources/39967/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[EpicFriends](https://www.spigotmc.org/resources/11294/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#epicfriends]]**]
- **[EpicLevels](https://songoda.com/marketplace/product/44)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#epiclevels]]**]
- **[Ersatz](https://www.spigotmc.org/resources/49433/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[essCore](https://www.spigotmc.org/resources/37766/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#esscore]]**]
- **[Essentials](https://ci.ender.zone/job/EssentialsX/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#essentials]]**]
- **[EZBlocks](https://www.spigotmc.org/resources/1499/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ezblocks]]**]
- **[EzChat](https://www.spigotmc.org/resources/75048/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[EZPrestige](https://www.spigotmc.org/resources/1794/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ezprestige]]**]
- **[EZRanksPro](https://www.spigotmc.org/resources/10731/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ezrankspro]]**]
----
## F
- **[FactionMapScoreboard](https://www.spigotmc.org/resources/23071/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Factions MCore](https://www.spigotmc.org/resources/1900/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#factions-mcore]]**]
- **[FactionsUUID](https://www.spigotmc.org/resources/1035/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#factionsuuid]]**]
- **[FunnyGuilds](https://github.com/FunnyGuilds/FunnyGuilds)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#funnyguilds]]**]
- **[FriendReferral](https://www.spigotmc.org/resources/21626/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
----
## G
- **[GangsPlus](https://www.spigotmc.org/resources/2604/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#gangsplus]]**]
- **[GemsEconomy](https://www.spigotmc.org/resources/19655/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#gemseconomy]]**]
- **[GriefDefender](https://www.spigotmc.org/resources/68900/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#griefdefender]]**]
- **[GriefPrevention](https://www.spigotmc.org/resources/1884/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#griefprevention]]**]
- **[Guilds](https://www.spigotmc.org/resources/48920/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#guilds]]**]
- **[GUIPlus](https://www.spigotmc.org/resources/38664/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
----
## H
- **[Hawn - Hub/Lobby Management](https://www.spigotmc.org/resources/66907/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Head Database](https://www.spigotmc.org/resources/14280/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#head-database]]**]
- **[HelpGUI](https://www.spigotmc.org/resources/33245/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[HeroChat Premium]()**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [**[[Link|Placeholders#herochat-premium]]**]
- **[Heroes](https://www.spigotmc.org/resources/305/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#heroes]]**]
- **[HoloBlock](https://www.spigotmc.org/resources/43192/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#holoblock]]**]
- **[HPWizard](https://www.spigotmc.org/resources/26821/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#hpwizard]]**]
- **[Hugs](https://www.spigotmc.org/resources/hugs.39722/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#hugs]]**]
----
## I
- **[InteractionVisualizer](https://www.spigotmc.org/resources/77050/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#interactionvisualizer]]**]
- **[IslandRate (ASkyBlock Addon)](https://www.spigotmc.org/resources/53519/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#islandrate-askyblock-addon]]**]
- **[IslandRate (AcidIsland Addon)](https://www.spigotmc.org/resources/54913/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#islandrate-acidisland-addon]]**]
- **[ItemJoin](https://www.spigotmc.org/resources/12661/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
----
## J
- **[Jobs Reborn](https://www.spigotmc.org/resources/4216/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#jobs-reborn]]**]
- **[JSONChat](https://www.spigotmc.org/resources/17744/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
----
## K
- **[Karma](https://www.spigotmc.org/resources/71156/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#karma]]**]
- **[KillStats](http://dev.bukkit.org/bukkit-plugins/killstats-v1-0/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#killstats]]**]
- **[KitPvP](https://www.spigotmc.org/resources/27107/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#kitpvp]]**]
- **[Kingdoms+](https://www.spigotmc.org/resources/11833/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#kingdoms]]**]
- **[KP-PVP](https://www.spigotmc.org/resources/50969/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#kp-pvp]]**]
----
## L
- **[LastLoginAPI](https://www.spigotmc.org/resources/66348/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#lastloginapi]]**]
- **[LeaderHeads](https://www.spigotmc.org/resources/2079/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#leaderheads]]**]
- **[Leak Parkour](https://www.spigotmc.org/resources/12852/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[LegendQuest](https://www.spigotmc.org/resources/2120/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#legendquest]]**]
- **[LemonMobCoins](https://www.spigotmc.org/resources/59402/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#lemonmobcoins]]**]
- **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#luckperms]]**]
- **[LWC (Modern LWC)](https://www.spigotmc.org/resources/2162/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#lwc]]**]
----
## M
- **[Marcely's Bedwars](https://www.spigotmc.org/resources/13622/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#marcelys-bedwars]]**]
- **[Marriage](https://www.spigotmc.org/resources/81807/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#marriage]]**]
- **[Marriage (reloaded)](https://www.spigotmc.org/resources/18998/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#marriage-reloaded]]**]
- **[MarriageMaster](http://dev.bukkit.org/bukkit-plugins/marriage-master/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#marriagemaster]]**]
- **[MCInfected](https://www.spigotmc.org/resources/2133/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mcinfected]]**]
- **[MCInfected-Ranks](https://www.spigotmc.org/resources/2826/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mcinfected-ranks]]**]
- **[McJobs](https://dev.bukkit.org/projects/mcjobs/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mcjobs]]**]
- **[McMMO](https://www.spigotmc.org/resources/2445/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mcmmo]]**]
- **[Menu](https://www.spigotmc.org/resources/50658/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[MineChess](https://www.spigotmc.org/resources/74178/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#minechess]]**]
- **[Minecord](https://www.spigotmc.org/resources/44055/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#minecord]]**]
- **[MineCrates](https://www.spigotmc.org/resources/4685/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#minecrates]]**]
- **[MinetopiaSDB](https://www.spigotmc.org/resources/28830/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[MixStepManager](https://www.spigotmc.org/resources/23531/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[MobHunting](https://www.spigotmc.org/resources/3582/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mobhunting]]**]
- **[MultiChat](https://www.spigotmc.org/resources/26204/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[MultiClan 2.0](https://www.spigotmc.org/resources/23927/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Multiverse-Core](https://www.spigotmc.org/resources/390/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#multiverse-core]]**]
- **[MurderMystery 2](https://www.spigotmc.org/resources/36894/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[MyCommand](http://dev.bukkit.org/bukkit-plugins/mycommand/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mycommand]]**]
- **[MyPet](https://www.spigotmc.org/resources/12725/) [[Premium](https://www.spigotmc.org/resources/17566/)]**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#mypet-premium]]**]
- **[MyPrefixSystem](https://www.spigotmc.org/resources/46244/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#myprefixsystem]]**]
----
## N
- **[Nameless Plugin](https://www.spigotmc.org/resources/59032/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#nameless-plugin]]**]
- **[Nicknamer](https://www.spigotmc.org/resources/5341/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#nicknamer]]**]
- **[NickReloaded](https://www.spigotmc.org/resources/46335/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#nickreloaded]]**]
- **[Nicky](https://www.spigotmc.org/resources/590/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#nicky]]**]
----
## O
- **[OnePlayerSleep](https://www.spigotmc.org/resources/76534/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#oneplayersleep]]**]
- **[OneTimeUse](https://www.spigotmc.org/resources/13907/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[OnTime](http://dev.bukkit.org/bukkit-plugins/ontime/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ontime]]**]
- **[OreAnnouncer](https://www.spigotmc.org/resources/33464/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#oreannouncer]]**]
- **[Outpost](https://www.spigotmc.org/resources/38657/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#outpost]]**]
----
## P
- **[Paintball Battle](https://www.spigotmc.org/resources/76676/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#paintball-battle]]**]
- **[Parkour](https://www.spigotmc.org/resources/23685/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#parkour]]**]
- **[Parties](https://www.spigotmc.org/resources/3709/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#parties]]**]
- **[Party and Friends](https://www.spigotmc.org/resources/11633/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#party-and-friends]]**]
- **[PingTest](https://www.spigotmc.org/resources/69580/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[PixelVip](https://www.spigotmc.org/resources/30438/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#pixelvip]]**]
- **[Plan](https://www.spigotmc.org/resources/32536/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#plan]]**]
- **[PlayerBalancerAddon](https://www.spigotmc.org/resources/51220/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[PlayTime](https://www.spigotmc.org/resources/26016/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#playtime]]**]
- **[PlayerPoints](http://dev.bukkit.org/bukkit-plugins/playerpoints/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#playerpoints]]**]
- **[PlotSquared](https://www.spigotmc.org/resources/1177/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#plotsquared]]**]
- **[PointsAPI](https://www.spigotmc.org/resources/13957/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#pointsapi]]**]
- **[Potatoes](https://www.spigotmc.org/resources/12353/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[PowerRanks](https://www.spigotmc.org/resources/64696/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#powerranks]]**]
- **[PremiumVanish](https://www.spigotmc.org/resources/14404/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#premiumvanish]]**]
- **[PrisonMines](https://www.spigotmc.org/resources/4046/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#prisonmines]]**]
- **[PrisonRanksX](https://www.spigotmc.org/resources/55899/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#prisonranksx]]**]
- **[ProCosmetics](https://www.spigotmc.org/resources/49106/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#procosmetics]]**]
- **[ProdigyGadget](https://www.spigotmc.org/resources/1335/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ProfessionalBans](https://www.spigotmc.org/resources/63657/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#professionalbans]]**]
- **[ProQuest](https://www.spigotmc.org/resources/18249/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#proquest]]**]
- **[ProtectionStones](https://www.spigotmc.org/resources/61797/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#protectionstones]]**]
- **[PurpleIRC](https://www.spigotmc.org/resources/2836/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[PvPLevels](https://www.spigotmc.org/resources/20807/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#pvplevels]]**]
- **[PvP Stats](http://dev.bukkit.org/bukkit-plugins/pvp-stats/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#pvp-stats]]**]
- **[PvPStats Plugin](https://www.spigotmc.org/resources/69984/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#pvpstats-plugin]]**]
- **[PyrCore](https://www.spigotmc.org/resources/24180/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
----
## Q
- **[Quests](https://www.spigotmc.org/resources/3711/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#quests]]**]
- **[QuestCreator](https://www.spigotmc.org/resources/38734/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#questcreator]]**]
- **[QuickBoard](https://www.spigotmc.org/resources/15057/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[QuickSell](https://www.spigotmc.org/resources/6107/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#quicksell]]**]
----
## R
- **[RabbitsVSPenguins](https://www.spigotmc.org/resources/65277/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#rabbitsvspenguins]]**]
- **[RageMode](https://www.spigotmc.org/resources/69169/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ragemode]]**]
- **[RankedHelp](https://www.spigotmc.org/resources/61919/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Rankup](https://www.spigotmc.org/resources/17933/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#rankup]]**]
- **[RawMSG](https://www.spigotmc.org/resources/35864/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[RecentFind (Treasures Add-on)](https://www.spigotmc.org/resources/33366/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#recentfind]]**]
- **[RedProtect](http://spigotmc.org/resources/15841/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#redprotect]]**]
- **[ReporterGUI](https://www.spigotmc.org/resources/8596/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[RestrictedDimensions](http://spigotmc.org/resources/80574/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#restricteddimensions]]**]
- **[RogueParkour](https://www.spigotmc.org/resources/26563/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#rogueparkour]]**]
- **[RoyalCommands](https://www.spigotmc.org/resources/4113/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#royalcommands]]**]
- **[ReferralSystem](https://www.spigotmc.org/resources/29709/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#referralsystem]]**]
- **[Residence](https://www.spigotmc.org/resources/11480/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[RPGInventory](https://www.spigotmc.org/resources/12498/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#rpginventory]]**]
----
## S
- **[Scoreboard Sidebar API](https://www.spigotmc.org/resources/21042/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ScrollBoard](https://www.spigotmc.org/resources/24697/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Skellett (Skript Add-on)](https://forums.skunity.com/resources/24/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SellAll](https://www.spigotmc.org/resources/1221/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#sellall]]**]
- **[Server List/Staff List](https://www.spigotmc.org/resources/15119/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ServerSelectorX](https://www.spigotmc.org/resources/32853/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SignLink](https://www.spigotmc.org/resources/39593/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#signlink]]**]
- **[SimpleBoard](https://www.spigotmc.org/resources/39597/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SimpleClans](https://www.spigotmc.org/resources/5269/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#simpleclans]]**]
- **[SimpleCoinsAPI](https://www.spigotmc.org/resources/1432/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#simplecoinsapi]]**]
- **[SimpleKillTracker](https://www.spigotmc.org/resources/17651/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#simplekilltracker]]**]
- **[SimplePrefix](http://dev.bukkit.org/bukkit-plugins/simple-prefix/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#simpleprefix]]**]
- **[Simple Suffix](http://dev.bukkit.org/bukkit-plugins/simple-suffix/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#simple-suffix]]**]
- **[SkillAPI](https://www.spigotmc.org/resources/4824/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#skillapi]]**]
- **[Skript](https://github.com/bensku/Skript)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#skript]]**]
- **[SkyWars](https://www.spigotmc.org/resources/6525/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SkyWarsReloaded](https://www.spigotmc.org/resources/3796/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#skywarsreloaded]]**]
- **[Spark](https://github.com/lucko/spark)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#spark]]**]
- **[SpigotBoard](https://www.spigotmc.org/resources/47497/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SpigotLib](https://www.spigotmc.org/resources/5925/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SpigotLobby](https://www.spigotmc.org/resources/58797/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SQLPerms](https://www.spigotmc.org/resources/1462/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#sqlperms]]**]
- **[SQLTokens](https://www.spigotmc.org/resources/3482/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#sqltokens]]**]
- **[sTablist](https://www.spigotmc.org/resources/12234/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Staff Facilities](https://www.spigotmc.org/resources/13097/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#staff-facilities]]**]
- **[Statz](https://www.spigotmc.org/resources/25969/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#statz]]**]
- **[StrikePractice 2](https://www.spigotmc.org/resources/46906/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#strikepractice-2]]**]
- **[stTitles](https://www.spigotmc.org/resources/8310/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#sttitles]]**]
- **[SubServers](https://github.com/ME1312/SubServers-2)**
- [ ] Supports Placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#subservers]]**]
- **[SuperbVote](https://www.spigotmc.org/resources/11626/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#superbvote]]**]
- **[SuperCredits](https://www.spigotmc.org/resources/31074/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#supercredits]]**]
- **[SuperScratch](https://www.spigotmc.org/resources/12250/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[SuperVanish](https://www.spigotmc.org/resources/1331/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#supervanish]]**]
----
## T
- **[TakaAntiCheat](https://www.spigotmc.org/resources/45167/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[The Time](https://www.spigotmc.org/resources/25146/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#the-time]]**]
- **[ThemePark](https://www.spigotmc.org/resources/48648/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#themepark]]**]
- **[Thirst](https://www.spigotmc.org/resources/3316/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#thirst]]**]
- **[Timed Rewards](https://www.spigotmc.org/resources/34008/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#timed-rewards]]**]
- **[Time Tokens](https://www.spigotmc.org/resources/75441/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#time-tokens]]**]
- **[TNTRun_Reloaded](https://www.spigotmc.org/resources/53359/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#tntrun_reloaded]]**]
- **[TokenEnchant](https://www.spigotmc.org/resources/2287/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#tokenenchant]]**]
- **[TokenManager](https://www.spigotmc.org/resources/8610/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#tokenmanager]]**]
- **[Tokens](https://www.spigotmc.org/resources/71941/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#tokens]]**]
- **[Towny](https://github.com/TownyAdvanced/Towny)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#towny]]**]
- **[TownyChat](https://github.com/TownyAdvanced/TownyChat)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#townychat]]**]
- **[TransmuteIt](https://www.spigotmc.org/resources/76287/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#transmuteIt]]**]
- **[Treasures](https://www.spigotmc.org/resources/14178/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#treasures]]**]
- **[Trey's Double Jump](https://www.spigotmc.org/resources/19630/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#treys-double-jump]]**]
- **[TrickOrTreat](https://www.spigotmc.org/resources/61370/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#trickortreat]]**]
----
## U
- **[UChat](https://www.spigotmc.org/resources/23767/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[UltimateAnnounce+](https://www.spigotmc.org/resources/7459/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[UltimateBossBar](https://www.spigotmc.org/resources/19303/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[UltimateSigns](https://www.spigotmc.org/resources/72462/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
- **[UltraChatFormat](https://www.spigotmc.org/resources/57929/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[UltraMenu](https://www.spigotmc.org/resources/27856/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Ultra Permissions](https://www.spigotmc.org/resources/42678/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Ultra Simple Staff Chat](https://www.spigotmc.org/resources/22064/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[USkyBlock](https://www.spigotmc.org/resources/2280/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#uskyblock]]**]
- **[UltimateChat](https://www.spigotmc.org/resources/uchat.23767/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ultimatechat]]**]
- **[UltimateVotes](https://www.spigotmc.org/resources/516)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#ultimatevote]]**]
- **[UnityGen](https://www.spigotmc.org/resources/26218/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#unitygen]]**]
----
## V
- **[VariableTriggers](https://dev.bukkit.org/projects/variabletriggers)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[Vault](http://dev.bukkit.org/bukkit-plugins/vault/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#vault]]**]
- **[VentureChat](https://www.spigotmc.org/resources/771/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[ViaVersion](https://www.spigotmc.org/resources/19254/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#viaversion]]**]
- **[VoteParty](https://www.spigotmc.org/resources/987/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#voteparty]]**]
- **[VoteRoulette](http://dev.bukkit.org/bukkit-plugins/voteroulette/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#voteroulette]]**]
- **[VotingPlugin](https://www.spigotmc.org/resources/15358/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#votingplugin]]**]
----
## W
- **[WickedSkyWars](https://www.spigotmc.org/resources/556/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#wickedskywars]]**]
- **[WonderHUD](https://www.spigotmc.org/resources/12220/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders. [Link]
- **[WorldGuard](https://dev.bukkit.org/bukkit-plugins/worldguard/)**
- [ ] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#worldguard]]**]
- **[WorldJoin](https://www.spigotmc.org/resources/63892/)**
- [x] Supports placeholders.
- [ ] Provides own placeholders.
----
## X
- **[XLTournaments](https://www.spigotmc.org/resources/70630/)**
- [x] Supports placeholders.
- [x] Provides own placeholders. [**[[Link|Placeholders#xltournaments]]**]

82
wiki/README.md Normal file
View File

@ -0,0 +1,82 @@
[Wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki
[Placeholders]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders
[Plugins using PlaceholderAPI]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders
# Wiki
This is the wiki folder. It contains all pages that you can find in our [Wiki].
It allows you to suggest changes through Pull request while keeping a simple way for us to maintain the wiki, without granting everyone push rights to it.
If you want to contribute towards the wiki would we highly recommend to follow the below contributing Guidelines, to keep the overal style of the wiki intact.
## Adding your resource(s)
If you have one or multiple resources that support PlaceholderAPI (being it by just supporting placeholders from other plugins, or providing your own) can you add them to the wiki in the following ways.
### [Plugins using PlaceholderAPI]
You should always add your resource to this page, no matter if it only supports placeholders or also provides its own.
The format of a plugin is always as follows:
```md
- **[:name](:url)**
- [?] Supports placeholders.
- [?] Provides own placeholders. [:link]
```
A quick summary over the different parts:
- `:name` is the name of your resource. The resources are ordered by alphabet and if yours has the same name as another one listed, add it __below__ the other resource.
- `:url` should be replaced with a URL to your resource page (Spigot, dev.bukkit, etc.). If you use Spigot, make sure to remove any text after the `/resources/` and only leave the ID. For example will https://www.spigotmc.org/resources/placeholderapi.6245/ become https://www.spigotmc.org/resources/6245/.
If you don't have your resource on any resource page can you either ommit the URL (Just provide the name) or provide a link to its source, if available.
- `?` should be replaced with either an `x` or a space depending on wether your plugin supports the option or not. So the `[?]` becomes either `[x]` or `[ ]`
- `:link` depends on wether your plugin provides own placeholders or not. If it doesn't, then you can just give `Link`. If it does provide placeholders, make sure to provide `[[Link|Placeholders#:name]]` where `:name` would be the name of your resource in the [Placeholders] page.
### [Placeholders]
If your plugin provides its own placeholders through an extension is it recommendet to add this extension to the [Placeholders] page.
This page is split up into two sections: PAPI Placeholders and Plugin Placeholders.
PAPI Placeholders are extensions that don't require an external plugin or other dependency to function normally. Common examples are the Player or Server extensions.
The Plugin Placeholders are extensions that require a plugin or other dependency to function. They are often used to provide values from one pluging (e.g. Vault) to another plugin through the help of PlaceholderAPI.
The overall structure of an entry is always the same:
````md
- ### **[:name](:url)**
> :command
```
:placeholders
```
----
````
- `:name` is the name of your resource. The resources are ordered by alphabet and if yours has the same name as another one listed, add it __below__ the other resource.
- `:url` should be replaced with a URL to your resource page (Spigot, dev.bukkit, etc.). If you use Spigot, make sure to remove any text after the `/resources/` and only leave the ID. For example will https://www.spigotmc.org/resources/placeholderapi.6245/ become https://www.spigotmc.org/resources/6245/.
If you don't have your resource on any resource page can you either ommit the URL (Just provide the name) or provide a link to its source, if available.
- `:command` depends on if your extension is available on the eCloud or is build into your resource. If you have it on the eCloud should you provide `/papi ecloud download :name` where `:name` is the name your expansion has on the eCloud.
If your extension is build into your resource can you just set `NO DOWNLOAD COMMAND` instead.
- `:placeholders` would be a list of all placeholders that your extension offers (Sorted by alphabet). If your placeholders support multiple variables like item names, should you use either `<text>` or `[text]` depending on if it is required or optional.
Always keep an empty line in between the `----` and the next entry below it.
If your extension is at the very bottom of the page can you ommit the `----`.
You will also need to add your extension's name to the list at the very top in the format `- **[:name](#:name)**` where `:name` is the extension name.
## Other Wiki pages
Please follow these general guidelines when editing any other pages.
### Linking
Linking should always be done through either the reference option or through the Wiki link option.
When the link leads to a page on the wiki should you use either `[[:page]]` or `[[:name|:page]]` where `:page` would be the name of the Wiki page (Case sensitive) and `:name` the text that would be displayed instead.
When linking to a section within a Wiki page should you link to it using a hashtag (`#`). For example would linking to the player extension result in `[[Placeholders#player]]` (Always have the section lowercase.
However, when you link to a section in the same wiki page should you do it in the format `[:name](#:section)` where `:name` is the text to display and `:section` is the name of the section.
When you link to an external page that isn't part of the wiki should you do it as a reference link (Exception is the above mentioned cases for resources and extensions).
You do this by adding `[:name]: :url` at the top of the page where `:name` is the reference name to use and `:url` is the url to link to.
You can then just use either `[:name]` or `[:display_text][:name]` to link to the url you set (`:display_text` could be any text (including spaces) to display).
Reference links are case-insensitive.
This system allows us to easly maintain the links without the need to update a URL on several places within the page.
### Lists
Lists should always be started with a hyphen (`-`) to better distinguish it from other formatting characters like the asterisk (`*`) used for bold or italic text.

16
wiki/_Footer.md Normal file
View File

@ -0,0 +1,16 @@
[discordImg]: https://img.shields.io/discord/164280494874165248.svg?logo=discord&label=Discord&colorB=7289DA
[discord]: https://helpch.at/discord
[jenkinsImg]: https://img.shields.io/badge/Download%20from-Jenkins-brightgreen.svg
[jenkins]: http://ci.extendedclip.com/job/PlaceholderAPI/
[licenseImg]: https://img.shields.io/github/license/PlaceholderAPI/PlaceholderAPI.svg
[license]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/LICENSE
[issuesImg]: https://img.shields.io/github/issues-raw/PlaceholderAPI/PlaceholderAPI.svg?logo=github&logoColor=white
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
[versionImg]: https://img.shields.io/nexus/r/http/repo.extendedclip.com/me.clip/placeholderapi.svg?label=API-Version
[plugin-page]: https://spigotmc.org/resources/6245
> Thanks for using PlaceholderAPI.
>
> **[Plugin-page]** | **[[Placeholders]]** | **[[Plugins using PlaceholderAPI]]** | **[[Hook into PlaceholderAPI]]**
![versionImg] [![jenkinsImg]][jenkins] [![licenseImg]][license] [![issuesImg]][issues] [![discordImg]][discord]

76
wiki/_Sidebar.md Normal file
View File

@ -0,0 +1,76 @@
<p align="center">
<img src="https://i.imgur.com/Adp7xdh.png" alt="PlaceholderAPI">
</p>
**[[Main page|Home]]**
### Setup
**[[Hook into PlaceholderAPI]]**
* [[First steps|Hook-into-PlaceholderAPI#first-steps]]
* [[Adding placeholders to PlaceholderAPI|Hook-into-PlaceholderAPI#adding-placeholders-to-placeholderapi]]
* [[PlaceholderExpansion]]
* [[Without an external plugin|PlaceholderExpansion#without-an-external-plugin]]
* [[With external plugin|PlaceholderExpansion#with-external-plugin]]
* [[Setting placeholders in your plugin|Hook-into-PlaceholderAPI#setting-placeholders-in-your-plugin]]
### Other
**[[Commands]]**
**[[Expansion cloud]]**
**[[FAQ]]**
**[[Plugins using PlaceholderAPI]]**
**[[Placeholders]]**
(Click the arrows to expand)
<details>
<summary> [[PAPI-placeholders|Placeholders#papi-placeholders-1]] </summary>
- [[Advancements|Placeholders#advancements]]
- [[BungeeCord|Placeholders#bungeecord]]
- [[CooldownBar|Placeholders#cooldownbar]]
- [[CheckItem|Placeholders#checkitem]]
- [[Javascript|Placeholders#javascript]]
- [[ListPlayers|Placeholders#listplayer]]
- [[Math|Placeholders#math]]
- [[MVdW placeholders|Placeholders#mvdw-placeholders]]
- [[OtherPlayer|Placeholders#otherplayer]]
- [[Pinger|Placeholders#pinger]]
- [[Player|Placeholders#player]]
- [[Plugin|Placeholders#plugin]]
- [[Progress|Placeholders#progress]]
- [[RainbowColor|Placeholders#rainbowcolor]]
- [[RandomColor|Placeholders#randomcolor]]
- [[RedisBungee|Placeholders#redisbungee]]
- [[RelCon|Placeholders#relcon]]
- [[ScoreboardObjectives|Placeholders#scoreboardobjectives]]
- [[Server|Placeholders#server]]
- [[Sound|Placeholders#sound]]
- [[Spectators|Placeholders#spectators]]
- [[Statistic|Placeholders#statistic]]
</details>
<details>
<summary> [[Plugin-placeholders|Placeholders#plugin-placeholders-1]] </summary>
- [[A|Placeholders#a]]
- [[B|Placeholders#b]]
- [[C|Placeholders#c]]
- [[D|Placeholders#d]]
- [[E|Placeholders#e]]
- [[F|Placeholders#f]]
- [[G|Placeholders#g]]
- [[H|Placeholders#h]]
- [[I|Placeholders#i]]
- [[J|Placeholders#j]]
- [[K|Placeholders#k]]
- [[L|Placeholders#l]]
- [[M|Placeholders#m]]
- [[N|Placeholders#n]]
- [[O|Placeholders#o]]
- [[P|Placeholders#p]]
- [[Q|Placeholders#q]]
- [[R|Placeholders#r]]
- [[S|Placeholders#s]]
- [[T|Placeholders#t]]
- [[U|Placeholders#u]]
- [[V|Placeholders#v]]
- [[W|Placeholders#w]]
- [[Z|Placeholders#z]]
</details>