First let's answer what is a placeholder exactly since the official PlaceholderAPI plugin doesn't even have a technical definition for it. What does it mean?

The word placeholder is a simple English word, however I'll try to explain it in Minecraft context specifically. A placeholder is simply a text that gets replaced by another text in a message.

For example, in this message $${\color{Gray}\text{My kingdom's name is }}{\color{OrangeRed}\text{\%kingdoms\_kingdom\_name\%}}$$. the placeholder %kingdoms_kingdom_name% gets replaced by the name of the player's kingdom. It's like variable x in math that gets replaced by a number. Now you might ask whose kingdom exactly? Well, it really depends, but generally it'd be the kingdom of the person who the message belongs to, and the message usually (but not always) belongs to the person who receives that message.

Placeholders work based on the context that they're used in. This is what determines what the value of the placeholder should be. PlaceholderAPI plugin generally works on player-based context, that means it shows values of placeholders based on which player that placeholder should be evaluated from. In most cases, like mentioned above, the context of the placeholder is the player who views the message, but not always. It can be any player.

For example a simple %kingdoms_kingdom_name% placeholder can be different if used for different players (if they're in different kingdoms). You can test this using the /papi parse <player> <message> command.

E.g.

• /papi parse me My kingdom's name is %kingdoms_kingdom_name%. -> "My kingdom's name is Apothicas."
• /papi parse pog_fucker69 pog_fucker69 kingdom's name is %kingdoms_kingdom_name%. -> "pog_fucker69 kingdom's name is Ballers."

More advanced plugins such as Kingdoms offer different types of contexts within the plugin itself (not via PlaceholderAPI because it only supports player context) such as a kingdom or a nation as a context. Depending on the type of context used, it can give you information about more placeholders.

In Kingdoms plugin specifically, the context of the placeholder can be changed by what's called a pointer. The format of the placeholder would be %pointer*placeholder%. The most common pointer/context is the other pointer which works when a certain event depends on the relationship between two things. Not all events/messages have two contexts, and messages almost never have more than 2 context. For example, lets say you want to configure a message that announces the death of a player by another player, you can write (using the player PAPI package):

$${\color{OrangeRed}\text{\%player\_name\%}} \text{ from kingdom } {\color{OrangeRed}\text{\%kingdoms\_kingdom\_name\%}} \text{ has killed } {\color{ForestGreen}\text{\%other*player\_name\%}} \text{ from kingdom } {\color{ForestGreen}\text{\%other*kingdoms\_kingdom\_name\%}}\text{.}$$

m

If we wanted a more technical definition of a placeholder, in its core placeholders are made out of at least 3 main components.
Format: %<identifier>_<name>%

• A placeholder is always surrounded by two percent signs. Anything between these percent signs including the percent signs themselves will be replaced by something else.
• The identifier which is a name to group a list of placeholders together to prevent conflicts. The identifier is always similar to the plugin name. For this plugin, KingdomsX, it's kingdoms
• The name of the placeholder which is separated by an underscore from the identifier. In our previous example, it was name
  • Sometimes placeholder names are longer than just one word, like %kingdoms_nation_name% which are separated by underscores. Almost all plugins that you use separate names with an underscore too.
  • The only thing all placeholders have in common are these 3 things. Plugins can do whatever they want with the name part. For example, kingdoms has a lot of syntactic features such as placeholder formats, modifiers, functions, etc which I explained further into the wiki.

What do placeholders do?
Almost 99% percent of the time placeholders only replace text with no side effects, but rarely they'll also have side effects.
Technically placeholders can do things ranging from replacing a simple text to crashing your system.

Who defines placeholders?
Placeholders are defined by plugins, their behavior is also defined by plugins.

What is PlaceholderAPI?
PlaceholderAPI is a Minecraft plugin that allows people to register and use placeholders.
One of the main benefits of this plugin is that it allows you to use placeholders from other plugins in other plugins. This is where the identifier part is important, to avoid placeholder conflicts since there are just so many plugins out there with their own placeholders.

Here's a list of placeholders that you can use.

There are two ways you can use placeholders defined by other plugins with this plugin. Some plugins like Kingdoms don't require any additional setup while other plugins have a separate package that PlaceholderAPI will download for you to use. For more information about downloading packages refer to Expansion Cloud guide.

PlaceholderAPI and most plugins will not yell at you if it finds a placeholder that doesn't know how to translate, it instead leaves it be without replacing it at all. Kingdoms however, will yell at you if it doesn't recognize a placeholder of its own (not the placeholder of other plugins)

I've seen a lot of placeholders with one word before.
If you've seen placeholders like %player%, %amount% %max_amount% before, these are standalone placeholders provided by plugins themselves. PlaceholderAPI doesn't handle these placeholders. For example, KingdomsX has two universal standalone placeholders %player% and %displaynane%. The former just shows the player name and the later shows the player name including any rank (permission plugin) prefix/suffix.

Kingdoms supports its own placeholders without needing a placeholder plugin. It supports PlaceholderAPI & MVdWPlaceholderAPI. You don't need to download the expansion from Papi ecloud, they're internally implemented into the plugin. The plugin's internal placeholder system is much more optimized than any other placeholder plugin, so it's technically better if you don't install these plugins when you don't need to use them, however the core syntax still remains the same.

Before you get started, as a reminder, you can test all the chat features using the /k admin test command.

Kingdoms has a very unique feature for showing numeric placeholders. These features can also be used via PlaceholderAPI.
Placeholder modifiers are a single word used before the placeholder id.
Format: %<modifier1>@<modifier2>@...kingdoms_<placeholder>% Multiple modifiers are rarely used. Only single ones, for example %fancy@kingdoms_kingdom_resource_points%

short A placeholder that is shortened with number suffixes for big numbers to fit in small messages.

fancy A placeholder that is formatted with the currency format ###.00.

roman A placeholder that is formatted as roman numerals. These are only useful for very small numbers (1 to 4000) if they're used for lower or higher numbers the plugin will error.

bool Works on placeholders that return either true or false such as %kingdoms_pacifist%. While seeing those words are sufficient to convey the meaning, it's still a little too format, and it's not international. One special language entry is enabled and disabled which is used instead of these values. When the value is true, it uses the enabled language entry and when false, it uses the disabled language entry. By default, enabled is a green ✔ and disabled is a red ❌

time Can be used on any number placeholder to turn it into the time formatter as specified inside each language file's time-formatter entry.

date Can be used on any number placeholder to turn it into the date formatter as specified inside each language file's date-formatter entry.

Also custom modifiers can be defined which works by determining what text to use depending on if the placeholder cannot be evaluated in the given context or can be evaluated. These are defined in config.yml

Normally when you use a placeholder like %kingdoms_kingdom_name% you get the kingdom's name or an empty text if the player doesn't have a kingdom. Now let's say you wanted to decorate this text and do something like [%kingdoms_kingdom_name%] this looks great when the player has a kingdom, but it'll show [] for players with no kingdom.

To solve this issue placeholder formats are defined in config:

formats:
  brackets:
    normal: '[%]'
    default: ''
  parens:
    normal: "(%)"
    default: ''

In order to use these you write %brackets@kingdoms_kingdom_name%, the same format used for any other modifier. In above % is a shorthand for the current placeholder.

%short@kingdoms_members% - %fancy@kingdoms_bank% - %roman@kingdoms_rank_priority%

The table below is unrelated to the placeholders above, it shows how different modifiers change how a value is shown.

Using these numbers on a time, date or a boolean modifier will give you back nonsensical results because those numbers weren't designed for these modifiers.

Most placeholders will depend on a certain context to get their information from. For example %kingdoms_kingdom_name% or %kingdoms_lore% will need you to be in a kingdom to get its name and lore, otherwise there is no kingdom to get its name or lore. For this reason, instead of having the plugin yell at you with a big error, the concept of default placeholders come into play.

If you don't have a kingdom, all the text (string) placeholder will output an empty text (no spaces) and all the number placeholders will give 0 with a few exceptions. These can be changed in config.yml placeholder section.

Macros are basically just custom defined placeholders that work only in Kingdoms plugin. They're defined by variables option in config.yml (for historical reasons) and can be used with {$<name>} format, where <name> is the name of the macro which is case-insensitive.

These messages are also translated like normal messages, you can use colors and placeholders in them. This is mostly useful to stop repeating the same thing over and over again and allows you to change its text for multiple places faster by just changing a single option which helps by allowing you to easily follow primary/secondary color theory for your messages.

Another set of macros can be defined per language. Which is under their variables section. Unlike the config.yml macros, these macros do not support conditional options, however both of these macro types can have other macros defined in them. So if you want a conditional macro for each language, define the condition in your config.yml then define the translatable message as separate macros in each language file and use the macro name in the the config.yml macro.

# config.yml
variables:
  enabled:
    enabled: '&8[&2{$enabled_lang}&8]'
  # ^^^^^^^ Note that the condition here used is a variable named "enabled" this is usually the variable defined inside GUIs
  # per option when they're toggled or not. Another way to better demonstrate this would be to define the condition like this instead:
  # 'enabled == true': '&8[&2{$enabled_lang}&8]'
    else: '&8[&4{$disabled_lang}&8]'
  # ^^^^^ this is a keyword that can be used for all conditions in the plugin, which basically
  # means "do this if other conditions failed" Note that the order of conditions are important.

# languages/en.yml
variables:
  enabled_lang: 'Enabled'
  disabled_lang: 'Disabled'

There is another syntax for language-level macros, instead of just accessing the values under the variables section, you can access any value within the language file. This allows for better organizing of your language file instead of listing them all under variables.

The syntax for these types of macros are: $${\color{Gray}\text{\{}}{\color{Red}\text{\$\$}}{\color{Orange}\text{language entry name}}{\color{Gray}\text{\}}}$$ where the language entry sections are separated by dots.

You can see these by default in buildings.yml declaration file. So for example, here, {$$building.holograms.main} refers to this message in en.yml:

buildings:
  # ...
  holograms:
    # ...
    main: "..."

Why do we define these variables as macros if we could simply just copy paste the text right there to be accessible? Because by using language-level macros, you're allowing the hologram text to be translatable. Since kingdoms spawns individual holograms for each player separately, it allows them to see translated holograms different from other players.

Imagine you have a message like this

&2Added %rank% &2to player &6%player%

And let's assume that the possible values for %rank% are [&6Admin] &c and [&eModerator] &e.

What if you wanted to change %player% color according to the last color captured by %rank%? In this case, it'd be either &c or &e. You can't simply do %rank%%player% because %rank% would be replaced by the entire rank text, however we only want the last color.

That's where color backreferences will be useful.

&2Added %rank% &2to player {%rank% & -1}%player%

{%rank% & -1} will be translated to the last color captured by the %rank% placeholder.
E.g. if %rank% is &8[&cAdmin&8] &6 using this special format gives you &6

The syntax for a color backreference declaration is {%placeholder% [& index]} - Where %placeholder% is simply the placeholder name, you should not put any space between { and the placeholder. - Where index is an optional position that the color should be retrieved from. Omitting this option (e.g. {%rank%}) is the equivalent of {%rank% & -1} which gives you the last color.
The position can be either positive or negative. Positive positions means that the search should start from the beginning of the placeholder while negative positions mean that the color search should start from the end of the string.

If you wanted to get the count of a specific type of structures in a land, normally you'd think that the placeholder would look something like %kingdoms_structures_powercell_count%, well that looks like a good guess, but the problem is that placeholders are predefined by the plugin itself. You can't make a new placeholder yourself and since you can make new structure styles yourself, it'd be very inefficient for the plugin to automatically create placeholders for each of these structures.

To solve this issue placeholder functions take some parameters and operate on that parameter instead.
Following our previous example %kingdoms_structures_powercell_count% is actually pretty close to the actual placeholder which is %kingdoms_structures:count style=powercell%

This format might look very weird at first, but it's really easy to understand, so let's take a look at each part.

• structures is simply the placeholder name, just like all the other placeholders.
• :count is saying that perform the count function (indicated by the colon :) for this placeholder. Note that the count function is unique to this placeholder and you can't use it with all other placeholders. For example you can't say %kingdoms_members:count% because there's nothing to calculate. %kingdoms_members% placeholder itself returns the calculated result.
• style=powercell Here style is a parameter of count function and its value is powercell (indicated by the equals sign =)

So the general format for placeholder functions is: %kingdoms_<placeholder>:<function> [parameters]%
Where parameters are zero or more <parameter name>=<parameter value> separated by commas.

Additionally instead of explicitly writing the parameter name, you can separate their values in the position they appear without commas. You can also omit the function name only if the placeholder has one function.
Format: %kingdoms_<placeholder> <parameters>% = zero or more <parameter value> separated by commas. E.g. %kingdoms_structures powercell% - %kingdoms_top 1 max_members%

How do I know the position these arguments appear in? Check the parameters in this guide!

Not many plugins support relational placeholders. They can only be used in other plugins if you have PlaceholderAPI plugin installed, however like normal placeholders, they'll work internally in Kingdoms plugin without PAPI installed. Relational placeholders are placeholders that require two players. This will check the kingdom relation between them to make new special placeholders.
If you're using these placeholders from PlaceholderAPI you need to add rel_ at the beginning, so the format would be %rel_<placeholder>%

Since land information in general cannot be inferred from players alone, these placeholders are rarely used for special contexts only. You can also use these placeholders for %kingdoms_lands:info name=<placeholder>% which works based on the land that the player is currently in.

These placeholders can be used with no context. They don't require a player, kingdom, nation and etc.

You can have multiple types of leaderboards /k top and /k nation top. There are also placeholders to use in other places.

All top placeholders are within %kingdoms_kingdom_top% and %kingdoms_nation_top% placeholders that allow multiple functional placeholders. I will list the following for kingdom top leaderboards, but it works for the nation placeholder too.

All placeholders have a type parameter that determines the leaderboard type to search in. Currently there are 4 predefined types:

• default The legacy "might"
• resource-points
• lands
• members

%kingdoms_kingdom_top:value [pos=<position>] type=topName%

%kingdoms_kingdom_top:position type=topName%

%kingdoms_kingdom_top:isIncluded type=topName%

%kingdoms_kingdom_top:at pos=targetPosition, type=topName, of=placeholder%

Examples

%kingdoms_kingdom_top:at pos=1, type=members, of=kingdom_name% -> Gives The Kingdom Name That Has The Most Members

Related FAQ: Top kingdoms placeholders