PlaceholderAPI

https://github.com/xinglingqaq/placeholderapi
Admin
PlaceholderAPI is a wiki repository that provides source code for managing and contributing to the...
Tokens:64,326
Snippets:378
Trust Score:5.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install MkDocs and Theme

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Installs MkDocs and the Material for MkDocs theme, which includes necessary dependencies for building and previewing the documentation. This command ensures all required packages are available for the documentation workflow.

```shell
pip install mkdocs-material

```

--------------------------------

### Start MkDocs Live Preview

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Initiates the MkDocs development server to provide a live preview of documentation changes. It serves the documentation locally, allowing real-time updates as files are modified. The `--open` flag automatically opens the preview in the default web browser.

```shell
mkdocs serve

```

```shell
mkdocs serve --open

```

--------------------------------

### List Registered Expansions

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Lists all currently active and registered expansions on the server. This differs from `ecloud list installed` as it includes expansions installed via plugins and does not show update availability.

```APIDOC
/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.
```

--------------------------------

### List eCloud Expansions

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Lists Expansions available on the eCloud. Supports filtering by all, a specific author, or currently installed expansions. Installed expansions are highlighted.

```APIDOC
/papi ecloud list <all|author|installed>

Description:
  Lists either all Expansions on the eCloud, only those by a specific author or only those that you have installed.
  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.

Examples:
  /papi ecloud list all
  /papi ecloud list clip
  /papi ecloud list installed
```

--------------------------------

### Clone PlaceholderAPI Wiki Repository

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Clones the PlaceholderAPI repository specifically targeting the 'wiki' branch. This command is essential for obtaining a local copy of the wiki content to make contributions.

```shell
git clone -b wiki https://github.com/<user>/PlaceholderAPI
```

--------------------------------

### Get Expansion Information

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Provides detailed information about a specific installed Expansion. The Expansion must be registered and active to retrieve its info.

```APIDOC
/papi info <expansion>

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
```

--------------------------------

### PlaceholderAPI Commands and Configuration

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/using-placeholders.md

Documentation for essential PlaceholderAPI commands and configuration options used for managing expansions. This includes downloading expansions from the eCloud and listing currently loaded expansions, as well as configuring blocked downloads via environment variables.

```APIDOC
PlaceholderAPI Commands and Configuration:

/papi ecloud download <expansion>
  - Downloads a specific expansion from the PlaceholderAPI eCloud.
  - Parameters:
    - expansion: The name of the expansion to download (e.g., 'player', 'server').
  - Returns: The downloaded expansion JAR file, placed in the 'expansions' folder.
  - Example: /papi ecloud download player

/papi list
  - Lists all currently loaded PlaceholderAPI expansions and the placeholders they provide.
  - Parameters: None.
  - Returns: A list of loaded expansions and their associated placeholders.
  - Example: /papi list

PAPI_BLOCKED_EXPANSIONS Environment Variable
  - Blocks the download of specific expansions from the eCloud.
  - Format: PAPI_BLOCKED_EXPANSIONS=<expansion1>,<expansion2>,...
  - Description: When set, PlaceholderAPI will not be able to download the listed expansions. This feature is available since version 2.11.4.
  - Example: PAPI_BLOCKED_EXPANSIONS=some_expansion,another_one
```

--------------------------------

### EssentialsX Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

This section lists placeholders for the Essentials and EssentialsX plugins. These placeholders provide information about player status, kits, homes, and economy. Ensure EssentialsX is installed and configured for full functionality.

```minecraft-placeholder
%essentials_afk%
%essentials_afk_reason%
%essentials_fly%
%essentials_geolocation%
%essentials_godmode%
%essentials_has_kit_<kitname>%
%essentials_home_<number>%
%essentials_home_<number>_<w|x|y|z>%
%essentials_homes_set%
%essentials_homes_max%
%essentials_is_muted%
%essentials_is_pay_confirm%
%essentials_is_pay_enabled%
%essentials_is_teleport_enabled%
%essentials_jailed%
%essentials_jailed_time_remaining%
%essentials_kit_is_available_<kitname>%
%essentials_kit_last_use_<kitname>%
%essentials_kit_time_until_available_<kitname>%
%essentials_kit_time_until_available_raw_<kitname>%
%essentials_msg_ignore%
%essentials_muted_time_remaining%
%essentials_nickname%
%essentials_nickname_stripped%
%essentials_pm_recipient%
%essentials_safe_online%
%essentials_unique%
%essentials_vanished%
%essentials_world_date%
%essentials_world_time%
%essentials_world_time_24%
%essentials_worth%
%essentials_worth:<item>%
%essentials_baltop_balance_fixed_<rank>%
%essentials_baltop_balance_formatted_<rank>%
%essentials_baltop_balance_commas_<rank>%
%essentials_baltop_balance_<rank>%
%essentials_baltop_player_<rank>%
%essentials_baltop_rank%
%essentials_baltop_player_stripped_<num>%
```

--------------------------------

### Download LuckPerms via PlaceholderAPI eCloud

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Command to download and install the LuckPerms extension for PlaceholderAPI using the eCloud system. This command simplifies the process of adding LuckPerms integration.

```APIDOC
papi ecloud download LuckPerms

Description:
  Downloads and installs the LuckPerms extension for PlaceholderAPI.

Usage:
  Execute this command in the Minecraft server console or as an operator in-game.

Prerequisites:
  - PlaceholderAPI plugin installed.
  - Server console access or operator privileges.

Related:
  - Refer to the LuckPerms wiki for an up-to-date list of available placeholders: https://luckperms.net/wiki/Placeholders
```

--------------------------------

### Java: Basic PlaceholderExpansion Example

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/creating-a-placeholderexpansion.md

This Java code demonstrates a basic external PlaceholderAPI expansion that does not rely on any specific plugin. It extends the PlaceholderExpansion class and implements methods to define the expansion's author, identifier, version, and how it handles placeholder requests.

```java
package at.helpch.placeholderapi.example.expansion;

import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;

public class SomeExpansion extends PlaceholderExpansion {
    
    @Override
    @NotNull
    public String getAuthor() {
        return "Author";
    }
    
    @Override
    @NotNull
    public String getIdentifier() {
        return "example";
    }
    
    @Override
    @NotNull
    public String getVersion() {
        return "1.0.0";
    }
    
    @Override
    public String onRequest(OfflinePlayer player, @NotNull String params) {
        if (params.equalsIgnoreCase("placeholder1")) {
            return "text1";
        }
        
        if (params.equalsIgnoreCase("placeholder2")) {
            return "text2";
        }
        
        return null; // (1)
    }
}
```

--------------------------------

### Register Expansion from File

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Registers an Expansion from a specified file located in the `/plugins/PlaceholderAPI/expansions` directory. This is useful for manually installed expansions or when avoiding server restarts.

```APIDOC
/papi register <filename>

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
```

--------------------------------

### Placeholder Expansion Command Types

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Specifies the different values to use for the `<command>` field when documenting how an expansion can be added, depending on its distribution method.

```APIDOC
Placeholder Expansion Command Types:

- integrated | Built into Plugin
  - Use when the expansion is built directly into a plugin.

- command | papi ecloud download <name of expansion>
  - Use when the expansion can be downloaded via the `/papi ecloud download` command.

- download | <link to download>
  - Use when the expansion is only available via external sources, such as a GitHub Release.
```

--------------------------------

### Stop MkDocs Live Preview

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Terminates the running MkDocs development server. This is typically done by pressing the key combination Ctrl+C in the terminal where the server was started.

```shell
Ctrl+C

```

--------------------------------

### Advancements Expansion Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides placeholders to display information about player advancements. Requires the Advancements expansion to be downloaded and installed.

```APIDOC
papi ecloud download Advancements

%advancements_<advancement>%
%advancements_player_<player>;<advancement>%
%advancements_list%
%advancements_list_<command>%
%advancements_playerList_<player>%
%advancements_playerList_<player>,<command>%
%advancements_listFormat%
%advancements_playerListFormat_<player>%
%advancements_completedAmount%
%advancements_completedAmount_<category>%
%advancements_playerCompletedAmount_<player>%
%advancements_playerCompletedAmount_<player>,<category>%
%advancements_remainingAmount%
%advancements_remainingAmount_<category>%
%advancements_playerRemainingAmount_<player>%
%advancements_playerRemainingAmount_<player>,<category>%
```

--------------------------------

### Add Files for Git Commit

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Stages specific files or all modified files in the repository for the next commit. `git add <file-path>` stages a single file, while `git add .` stages all changes in the current directory and its subdirectories.

```shell
git add <file-path>

```

```shell
git add .

```

--------------------------------

### Java PlaceholderExpansion Example

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/creating-a-placeholderexpansion.md

This Java code snippet demonstrates the fundamental structure for creating a custom expansion for the PlaceholderAPI plugin. It includes overriding essential methods like getAuthor, getIdentifier, getVersion, and placeholder request handlers.

```Java
package at.helpch.placeholderapi.example.expansion;

import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.jetbrains.annotations.NotNull;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;

public class SomeExpansion extends PlaceholderExpansion {
    
    @Override
    @NotNull
    public String getAuthor() {
        return "Author"; // (1)
    }
    
    @Override
    @NotNull
    public String getIdentifier() {
        return "example"; // (2)
    }

    @Override
    @NotNull
    public String getVersion() {
        return "1.0.0"; // (3)
    }

    // These methods aren't overriden by default.
    // You have to override one of them.
    
    @Override
    public String onRequest(OfflinePlayer player, @NotNull String params) {
        // (4)
        return null; // Default return if not handled
    }
    
    @Override
    public String onPlaceholderRequest(Player player, @NotNull String params) {
        // (5)
        return null; // Default return if not handled
    }
}
```

--------------------------------

### Create New Git Branch

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Creates a new local branch from the current branch. This is a recommended practice to isolate your changes and avoid conflicts with the main wiki branch.

```shell
git checkout -b <branch>
```

--------------------------------

### Markdown Formatting Notes

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Key rules for Markdown formatting within the project, emphasizing proper list indentation, line breaks, relative linking, and the use of extensions like Admonition, Details, Tabs, and MagicLink for enhanced content presentation.

```markdown
- Lists require an empty line before themself to be rendered as such.
- New lines in lists need to have an indent of 4 spaces.
  - This indent also applies to nested list entries.
- Links to other files should be relative and also include the file name itself.

Features:
- Admonition blocks
- Details (`<details>` HTML tag)
- Tabs
- Automatic linking of issues, PRs, discussions using `!<id>`, `#<id>` and `?<id>`

```

--------------------------------

### Placeholder Entry Format

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Defines the required markdown structure for adding new placeholder expansions to the Placeholder List page. This includes naming conventions, linking, command specification, optional text, and placeholder syntax.

```Markdown
### [<name>](<link>)
/// <command>
/// 

<text> 

```
<placeholders>
```
```

--------------------------------

### Switch to Existing Git Branch

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Switches the current working branch to an existing one. This command is useful if you have already created a branch on GitHub and want to switch to it locally after cloning.

```shell
git switch <branch>
```

--------------------------------

### Generate Debug Paste

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Pastes essential PlaceholderAPI information, including plugin version, server version, and installed expansions, to a sharing service (https://paste.helpch.at) for easy support and debugging.

```APIDOC
/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.
```

--------------------------------

### Placeholder Syntax Convention

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Illustrates the recommended convention for writing placeholder names in documentation, emphasizing the use of angle brackets for required values and square brackets for optional values.

```APIDOC
Placeholder Syntax Convention:

- Avoid explicit examples like `%expansion_SomePlayer%`.
- Use placeholders like `%expansion_<player>%` to indicate required or optional values.
```

--------------------------------

### Java Plugin Example: Custom Join Message

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/using-placeholderapi.md

Demonstrates how to use PlaceholderAPI's `setPlaceholders` method within a Bukkit plugin to create custom join messages. It includes checks for PlaceholderAPI's presence and registers events.

```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;

public class JoinExample extends JavaPlugin implements Listener {

    @Override
    public void onEnable() {
 
        if (Bukkit.getPluginManager().isPluginEnabled("PlaceholderAPI")) {
            Bukkit.getPluginManager().registerEvents(this, this); // (1)
        } else {
            getLogger().warn("Could not find PlaceholderAPI! This plugin is required."); // (2)
            Bukkit.getPluginManager().disablePlugin(this);
        }
    }

    @EventHandler(priority = EventPriority.HIGHEST)
    public void onJoin(PlayerJoinEvent event) {
        String joinText = "%player_name% joined the server! They are rank %vault_rank%";

        joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText); // (3)

        event.setJoinMessage(joinText);
    }
}
```

--------------------------------

### Display Help

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Displays a list of all available commands provided by PlaceholderAPI. This is a quick reference for users to see what actions can be performed.

```APIDOC
/papi help

Description:
  Displays all the commands PlaceholderAPI currently offers.
```

--------------------------------

### Creating and Uploading a PlaceholderAPI Expansion

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/expansion-cloud.md

Steps involved in creating a custom PlaceholderAPI expansion as a Java JAR file and uploading it to the expansion cloud.

```APIDOC
Expansion Creation and Upload Process:

1. Create Expansion JAR:
   - Develop your custom expansion following the guidelines in the [Creating a PlaceholderExpansion](creating-a-placeholderexpansion.md) documentation.
   - Ensure the expansion is packaged into a separate JAR file.

2. Upload to eCloud:
   - Create an account or log in to the PlaceholderAPI eCloud website (https://api.extendedclip.com/home).
   - Navigate to the 'Expansions' section and click 'Upload New' (https://api.extendedclip.com/manage/add/).
   - Fill in the required fields, including:
     - Expansion Name
     - Version
     - Description
     - Optional: Source URL, Dependency URL
   - Upload the expansion JAR file.
     - **Important:** The JAR file name must match the version specified in the upload form (e.g., `MyExpansion-1.0.0.jar`).
   - Click 'Submit Expansion'.

3. Review and Verification:
   - Submitted expansions are reviewed by moderators.
   - Upon approval, the expansion becomes available on the eCloud for others to download.

Updating an Expansion:
   - Go to 'Your Expansions' on the eCloud management page (https://api.extendedclip.com/manage/).
   - Select the expansion to update.
   - Click the 'Version' button, then 'Add Version'.
   - Fill in the new version details and upload the updated JAR file.
   - **Note:** Updating an expansion marks it as unverified, requiring re-verification by a moderator.
```

--------------------------------

### PlaceholderAPI CLI Commands

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/faq.md

Common commands used to interact with the PlaceholderAPI plugin via the in-game command line interface. These commands help manage expansions, parse placeholders, and troubleshoot issues.

```APIDOC
Command: /papi ecloud download <expansion>
Description: Downloads a verified expansion from the PlaceholderAPI eCloud. This is used when an expansion is not bundled with a plugin.
Example: /papi ecloud download server
```

```APIDOC
Command: /papi parse me %placeholder%
Description: Parses a specific placeholder for the player executing the command. Useful for testing if a placeholder is working correctly.
Example: /papi parse me %server_online% (if server_online is a valid placeholder)
```

```APIDOC
Command: /papi ecloud placeholders <expansion>
Description: Lists all available placeholders provided by a specific expansion downloaded from the eCloud. This helps verify placeholder names and check for typos.
Example: /papi ecloud placeholders player
```

```APIDOC
Command: /papi reload
Description: Reloads PlaceholderAPI and its expansions. This command is often necessary after manually adding or updating expansion files in the plugins directory.
Example: /papi reload
```

--------------------------------

### Unicode Expansion Placeholder

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Enables displaying Unicode characters by providing their hexadecimal value. For example, `%unicode_1000%` displays `က`.

```APIDOC
Unicode Expansion Placeholder:

%unicode_<hex value>%

Example: %unicode_1000% would show က
```

--------------------------------

### OtherPlayer Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Retrieves placeholders for other players on the server, identified by their username or UUID. Examples include display name, gamemode, health, and permissions.

```plaintext
%otherplayer_displayname_<player>%
```

```plaintext
%otherplayer_gamemode_<player>%
```

```plaintext
%otherplayer_hasperm_<player>_perm_<permission.string>%
```

```plaintext
%otherplayer_haspotioneffect_<player>_effect_<effect_name>%
```

```plaintext
%otherplayer_health_<player>%
```

```plaintext
%otherplayer_hunger_<player>%
```

```plaintext
%otherplayer_iteminhand_<player>%
```

```plaintext
%otherplayer_ip_<player>%
```

```plaintext
%otherplayer_level_<player>%
```

```plaintext
%otherplayer_locx_<player>%
```

```plaintext
%otherplayer_locy_<player>%
```

```plaintext
%otherplayer_locz_<player>%
```

```plaintext
%otherplayer_oxygen_<player>%
```

```plaintext
%otherplayer_spells_<player>%
```

```plaintext
%otherplayer_uuid_<player>%
```

```plaintext
%otherplayer_world_<player>%
```

--------------------------------

### Get eCloud Status

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Displays the current status of the eCloud connection and data. This can help diagnose issues with fetching expansion information.

```APIDOC
/papi ecloud status

Description:
  Displays the actual Status of the eCloud.
```

--------------------------------

### PlaceholderAPI eCloud Management Commands

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/expansion-cloud.md

Commands for interacting with the PlaceholderAPI expansion cloud (eCloud) to download, manage, and view expansion information. These commands are executed in-game or in the server console.

```APIDOC
PlaceholderAPI Commands:

/papi ecloud download <expansion> [version]
  - Description: Downloads a specified expansion from the eCloud. If a version is provided, it downloads that specific version; otherwise, it downloads the latest available version.
  - Parameters:
    - expansion: The name of the expansion to download (e.g., "server").
    - version (optional): The specific version string of the expansion to download (e.g., "1.0.0").
  - Usage Example: `/papi ecloud download server 1.5.0`
  - Related Commands: `/papi ecloud info`, `/papi reload`

/papi ecloud info <expansion>
  - Description: Displays information about a specific expansion, including available versions.
  - Parameters:
    - expansion: The name of the expansion to get information about.
  - Usage Example: `/papi ecloud info player`
  - Related Commands: `/papi ecloud download`, `/papi reload`

/papi reload
  - Description: Reloads all installed expansions and refreshes PlaceholderAPI's internal data. This command is often necessary after downloading or updating expansions.
  - Usage Example: `/papi reload`
  - Related Commands: `/papi ecloud download`, `/papi ecloud info`

Configuration:
  - cloud_enabled: A boolean setting in `config.yml` to enable or disable the connection to the eCloud. Defaults to true.

Environment Variable:
  - PAPI_BLOCKED_EXPANSIONS: A comma-separated list of expansion names that should not be downloadable via the eCloud. This feature is available since version 2.11.4.
```

--------------------------------

### Java: PlaceholderExpansion with Plugin Dependency

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/developers/creating-a-placeholderexpansion.md

This Java code illustrates an external PlaceholderAPI expansion that requires a specific plugin ('SomePlugin') to function. It shows how to declare the dependency, check for its availability, and access plugin-specific configurations or data within the expansion's logic.

```java
package at.helpch.placeholderapi.example.expansion;

import at.helpch.placeholderapi.example.SomePlugin;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;

public class SomeExpansion extends PlaceholderExpansion {
    
    private SomePlugin plugin; // (1)
    
    @Override
    @NotNull
    public String getAuthor() {
        return "Author";
    }
    
    @Override
    @NotNull
    public String getIdentifier() {
        return "example";
    }
    
    @Override
    @NotNull
    public String getVersion() {
        return "1.0.0";
    }
    
    @Override
    public String getRequiredPlugin() {
        return "SomePlugin"; // (2)
    }
    
    @Override
    public boolean canRegister() { // (3)
        return (plugin = (SomePlugin) Bukkit.getPluginManager().getPlugin(getRequiredPlugin())) != null;
    }
    
    @Override
    public String onRequest(OfflinePlayer player, @NotNull String params) {
        if (params.equalsIgnoreCase("placeholder1")) {
            return plugin.getConfig().getString("placeholders.placeholder1", "default1"); // (4)
        }
        
        if (params.equalsIgnoreCase("placeholder2")) {
            return plugin.getConfig().getString("placeholders.placeholder1", "default1"); // (5)
        }
        
        return null; // (6)
    }
}
```

--------------------------------

### PlaceholderAPI Other Commands

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

General utility commands for PlaceholderAPI. These include dumping plugin information, accessing help, reloading configurations, and checking the plugin version.

```APIDOC
/papi dump
  - Dumps information about the PlaceholderAPI plugin and its expansions.

/papi help
  - Displays the help message for PlaceholderAPI commands.

/papi reload
  - Reloads the PlaceholderAPI configuration and expansions.

/papi version
  - Displays the current version of PlaceholderAPI.
```

--------------------------------

### Pinger Placeholder Usage

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Checks the online status and retrieves information (version, player count, MOTD) for a specified server IP and port. Placeholders have a warmup period. Example: %pinger_online_testplugins.com:25565%.

```plaintext
%pinger_gameversion_testplugins.com:25565%
```

```plaintext
%pinger_version_testplugins.com:25565%
```

```plaintext
%pinger_online_testplugins.com:25565%
```

```plaintext
%pinger_isonline_testplugins.com:25565%
```

```plaintext
%pinger_max_testplugins.com:25565%
```

```plaintext
%pinger_players_testplugins.com:25565%
```

```plaintext
%pinger_motd_testplugins.com:25565%
```

```plaintext
%pinger_pingversion_testplugins.com:25565%
```

--------------------------------

### PlaceholderAPI: SQLPerms Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Retrieves rank and prefix information from the SQLPerms plugin, allowing dynamic display of player ranks and chat prefixes based on configured channels.

```PlaceholderAPI
%sqlperms_rank_<channel>%
%sqlperms_prefix_<chanel>%
```

--------------------------------

### PlaceholderAPI eCloud Commands

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/commands.md

Commands related to the Expansion Cloud, used for managing expansions. These commands allow clearing cache, enabling/disabling connections, downloading, and getting information about expansions.

```APIDOC
/papi ecloud clear
  - Clears the cache for the eCloud.

/papi ecloud disable
  - Disables the connection to the eCloud.

/papi ecloud download <expansion> [version]
  - 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
  - Enables the connection to the eCloud.

/papi ecloud info <expansion> [version]
  - 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
```

--------------------------------

### MyPrefixSystem PlaceholderAPI Variables

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides placeholders for displaying rank information managed by the MyPrefixSystem plugin. This includes rank name, prefix, suffix, and associated color codes. Requires MyPrefixSystem and PlaceholderAPI.

```PlaceholderAPI
%myprefixsystem_rank_name%
%myprefixsystem_rank_prefix%
%myprefixsystem_rank_suffix%
%myprefixsystem_rank_color%
```

--------------------------------

### McJobs PlaceholderAPI Variables

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides placeholders to retrieve job-related information from the McJobs plugin. These variables allow displaying player jobs, ranks, levels, and experience points. Requires McJobs and PlaceholderAPI to be installed.

```PlaceholderAPI
%mcjobs_jobslist%
%mcjobs_playerjobs%
%mcjobs_ranks%
%mcjobs_levels%
%mcjobs_(original jobname)_name%
%mcjobs_(original jobname)_has%
%mcjobs_(original jobname)_rank%
%mcjobs_(original jobname)_level%
%mcjobs_(original jobname)_exp%
%mcjobs_(original jobname)_exptolvlup%
%mcjobs_(original jobname)_nextlvlexp%
%mcjobs_(original jobname)_language%
%mcjobs_paycache%
```

--------------------------------

### Plan Plugin Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Placeholders for accessing player and server statistics stored by the Plan plugin. Refer to the Plan Wiki for a comprehensive list.

```PlaceholderAPI
Refer to Plan Wiki for placeholders list.
```

--------------------------------

### Teams Expansion Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides access to team name, color, prefix, and suffix. This expansion is downloaded via `papi ecloud download teams`.

```APIDOC
Teams Expansion Placeholders:

%team_color%
%team_prefix%
%team_suffix%
%team_name%
```

--------------------------------

### SubServers Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides access to information about SubServers proxies, hosts, servers, and subservers. Includes details like display names, player counts, status, and configuration. These placeholders are integrated directly into the SubServers plugin.

```APIDOC
SubServers Proxies:
  %subservers_proxies()%
  %subservers_proxy.displayname(<Proxy>)%
  %subservers_proxy.type(<Proxy>)_{Master Proxy, Proxy}%
  %subservers_proxy.players(<Proxy>)%
  %subservers_proxy.subdata(<Proxy>)_{Connected, Disconnected}%
  %subservers_proxy.subdata.channels(<Proxy>)%
  %subservers_proxy.subdata.subchannels(<Proxy>)%
  %subservers_proxy.signature(<Proxy>)%

SubServers Hosts:
  %subservers_hosts()%
  %subservers_host.displayname(<Host>)%
  %subservers_host.available(<Host>)_{Available, Unavailable}%
  %subservers_host.enabled(<Host>)_{Enabled, Disabled}%
  %subservers_host.address(<Host>)%
  %subservers_host.creator.templates(<Host>)%
  %subservers_host.creator.template.displayname(<Host>, <Template>)%
  %subservers_host.creator.template.enabled(<Host>, <Template>)_{Enabled, Disabled}%
  %subservers_host.creator.template.type(<Host>, <Template>)%
  %subservers_host.creator.template.requiresversion(<Host>, <Template>)_{Optional, Required}%
  %subservers_host.creator.template.updatable(<Host>, <Template>)_{Updatable, Not Updatable}%
  %subservers_host.subservers(<Host>)%
  %subservers_host.players(<Host>)%
  %subservers_host.subdata(<Host>)_{Connected, Unsupported, Disconnected}%
  %subservers_host.subdata.channels(<Host>)%
  %subservers_host.subdata.subchannels(<Host>)%
  %subservers_host.signature(<Host>)%

SubServers Servers:
  %subservers_servers()%
  %subservers_server.displayname(<Server>)%
  %subservers_server.type(<Server>)_{Subserver, Server}%
  %subservers_server.groups(<Server>)%
  %subservers_server.address(<Server>)%
  %subservers_server.motd(<Server>)%
  %subservers_server.restricted(<Server>)_{Public, Private}%
  %subservers_server.hidden(<Server>)_{Visible, Hidden}%
  %subservers_server.players(<Server>)%
  %subservers_server.subdata(<Server>)_{Connected, Disconnected}%
  %subservers_server.subdata.channels(<Server>)%
  %subservers_server.subdata.subchannels(<Server>)%
  %subservers_server.signature(<Server>)%

SubServers Subservers:
  %subservers_subservers()%
  %subservers_subserver.displayname(<Subserver>)%
  %subservers_subserver.available(<Subserver>)_{Available, Unavailable}%
  %subservers_subserver.enabled(<Subserver>)_{Enabled, Disabled}%
  %subservers_subserver.editable(<Subserver>)_{Editable, Locked}%
  %subservers_subserver.host(<Subserver>)%
  %subservers_subserver.template(<Subserver>)%
  %subservers_subserver.template.displayname(<Subserver>)%
  %subservers_subserver.template.enabled(<Subserver>)_{Enabled, Disabled}%
  %subservers_subserver.template.type(<Subserver>)%
  %subservers_subserver.template.requiresversion(<Subserver>)_{Optional, Required}%
  %subservers_subserver.template.updatable(<Subserver>)_{Updatable, Not Updatable}%
  %subservers_subserver.groups(<Subserver>)%
  %subservers_subserver.address(<Subserver>)%
  %subservers_subserver.motd(<Subserver>)%
  %subservers_subserver.logging(<Subserver>)_{Logging, Muted}%
  %subservers_subserver.running(<Subserver>)_{Running, Offline}%
  %subservers_subserver.online(<Subserver>)_{Online, Starting, Offline}%
  %subservers_subserver.temporary(<Subserver>)_{Permanent, Temporary}%
  %subservers_subserver.stopaction(<Subserver>)%
  %subservers_subserver.incompatibilities(<Subserver>)%
  %subservers_subserver.incompatibilities.current(<Subserver>)%
  %subservers_subserver.restricted(<Subserver>)_{Public, Private}%
  %subservers_subserver.hidden(<Subserver>)_{Visible, Hidden}%
  %subservers_subserver.players(<Subserver>)%
  %subservers_subserver.subdata(<Subserver>)_{Connected, Disconnected}%
  %subservers_subserver.subdata.channels(<Subserver>)%
  %subservers_subserver.subdata.subchannels(<Subserver>)%
  %subservers_subserver.signature(<Subserver>)
```

--------------------------------

### Parties Plugin Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Placeholders for retrieving color codes, command information, descriptions, player stats, and party details from the Parties plugin.

```PlaceholderAPI
%parties_color_code%
%parties_color_command%
%parties_color_name%
%parties_desc%
%parties_kills%
%parties_motd%
%parties_party%
%parties_rank_chat%
%parties_rank_name%
```

--------------------------------

### Player Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides a comprehensive list of placeholders related to player information. These placeholders can display various player attributes such as health, location, inventory, and status. Usage requires the Player expansion to be installed and enabled in PlaceholderAPI.

```PlaceholderAPI
%player_allow_flight%
%player_armor_helmet_name%
%player_armor_helmet_data%
%player_armor_helmet_durability%
%player_armor_chestplate_name%
%player_armor_chestplate_data%
%player_armor_chestplate_durability%
%player_armor_leggings_name%
%player_armor_leggings_data%
%player_armor_leggings_durability%
%player_armor_boots_name%
%player_armor_boots_data%
%player_armor_boots_durability%
%player_bed_x%
%player_bed_y%
%player_bed_z%
%player_bed_world%
%player_biome%
%player_biome_capitalized%
%player_block_underneath%
%player_can_pickup_items%
%player_colored_ping%
%player_compass_world%
%player_compass_x%
%player_compass_y%
%player_compass_z%
%player_custom_name%
%player_current_exp%
%player_direction%
%player_direction_xz%
%player_displayname%
%player_list_name%
%player_exp%
%player_exp_to_level%
%player_first_join_date%
%player_first_played%
%player_first_join%
%player_first_played_formatted%
%player_fly_speed%
%player_food_level%
%player_gamemode%
%player_has_empty_slot%
%player_has_played_before%
%player_empty_slots%
%player_has_health_boost%
%player_has_potioneffect_<effect>%
%player_has_permission_<permission>%
%player_health%
%player_health_boost%
%player_health_rounded%
%player_health_scale%
%player_ip%
%player_online%
%player_is_whitelisted%
%player_is_banned%
%player_is_flying%
%player_is_sneaking%
%player_is_sprinting%
%player_is_sleeping%
%player_is_inside_vehicle%
%player_is_op%
%player_item_in_hand%
%player_item_in_hand_name%
%player_item_in_hand_data%
%player_item_in_hand_durability%
%player_item_in_hand_level_<enchantment>%
%player_item_in_offhand%
%player_item_in_offhand_name%
%player_item_in_offhand_data%
%player_item_in_offhand_durability%
%player_item_in_offhand_level_<enchantment>%
%player_locale%
%player_locale_display_name%
%player_locale_short%
%player_locale_country%
%player_locale_display_country%
%player_last_damage%
%player_last_played%
%player_last_join%
%player_last_played_formatted%
%player_last_join_date%
%player_level%
%player_light_level%
%player_max_air%
%player_max_health%
%player_max_health_rounded%
%player_max_no_damage_ticks%
%player_minutes_lived%
%player_name%
%player_no_damage_ticks%
%player_ping%
%player_ping_<playername>%
%player_remaining_air%
%player_saturation%
%player_seconds_lived%
%player_sleep_ticks%
%player_thunder_duration%
%player_ticks_lived%
%player_time%
%player_time_offset%
%player_total_exp%
%player_uuid%
%player_walk_speed%
%player_weather_duration%
%player_world%
%player_world_type%
%player_world_time_12%
%player_world_time_24%
%player_x%
%player_y%
%player_z%
%player_yaw%
%player_pitch%
%player_absorption%
```

--------------------------------

### PlaceholderAPI LemonMobCoins Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides placeholders for LemonMobCoins plugin, allowing display of player balances in various formats. Requires downloading the expansion.

```APIDOC
%lemonmobcoins_balance%
%lemonmobcoins_balance_fixed%
%lemonmobcoins_balance_formatted%
```

--------------------------------

### Push Commits to Remote Repository

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Uploads local commits to a remote repository. If a new branch was created locally, `--set-upstream` is used to link it to the remote branch for future pushes and pulls.

```shell
git push

```

```shell
git push --set-upstream origin <branch>

```

--------------------------------

### KP-PVP Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Placeholders for the KP-PVP plugin, providing player-specific data like kills, deaths, coins, kill streak, kit, level, and experience. Also includes server-wide player counts and checks for being on kitpvp.

```APIDOC
%kp-pvp_player_kills%
%kp-pvp_player_deaths%
%kp-pvp_player_coins%
%kp-pvp_player_streak%
%kp-pvp_player_is_on_kitpvp%
%kp-pvp_players_count_total%
%kp-pvp_player_kit%
%kp-pvp_player_level%
%kp-pvp_player_xp%
```

--------------------------------

### Commit Staged Changes

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/README.md

Records the staged changes to the repository's history. This command opens a text editor for writing a commit message, or alternatively, the `-m` flag can be used to provide the message directly on the command line.

```shell
git commit

```

```shell
git commit -m "Your commit message"

```

--------------------------------

### PvPManager Placeholders

Source: https://github.com/xinglingqaq/placeholderapi/blob/wiki/docs/users/placeholder-list.md

Provides placeholders for tracking player combat status, combat time remaining, PvP status, and newbie status from the PvPManager plugin. Refer to the PvPManager Wiki for detailed explanations.

```placeholder
%pvpmanager_in_combat%
%pvpmanager_combat_timeleft%
%pvpmanager_combat_prefix%
%pvpmanager_pvp_status%
%pvpmanager_pvp_status_prefix%
%pvpmanager_pvp_command_timeleft%
%pvpmanager_is_newbie%
%pvpmanager_newbie_timeleft%
%pvpmanager_newbie_timeleft_formatted%
%pvpmanager_grant_timeleft%
%pvpmanager_has_override%
%pvpmanager_has_respawn_prot%
%pvpmanager_has_teleport_prot%
%pvpmanager_current_enemy%
%pvpmanager_current_enemy_health%
```
Tokens:
Raw