Placeholders - Hexaoxide/Carbon GitHub Wiki

MiniPlaceholders (All platforms)

MiniPlaceholders is a modern placeholder API for MiniMessage.

Placeholders from MiniPlaceholders can be used in most message formats.

PlaceholderAPI (Paper servers)

Carbon provides the following placeholders to PlaceholderAPI:

Placeholder	Description
%carbonchat_party%	Returns the player's current party in MiniMessage formatting. Will be blank if they are not in a party.
%carbonchat_party_l%	Returns the player's current party in legacy section sign formatting. Will be blank if they are not in a party.
%carbonchat_nickname%	Returns the player's nickname (or username if none is set) in MiniMessage formatting.
%carbonchat_nickname_l%	Returns the player's nickname (or username if none is set) in legacy section sign formatting.
%carbonchat_displayname%	Returns the player's display name (formatted nickname or username) in MiniMessage formatting.
%carbonchat_displayname_l%	Returns the player's display name (formatted nickname or username) in legacy section sign formatting.
%carbonchat_channel_key%	Returns the channel key of the player's currently joined channel

Placeholders from PlaceholderAPI can be used in many message formats out of the box, in their usual %placeholder% format.

Placeholders that contain legacy color codes (&###### or &4, etc.) that are used for channel formats should use Kyorify in order to convert them to MiniMessage format. (ex. %kyorify_luckperms_prefix% over %luckperms_prefix%)

Use MiniPlaceholders (see above section) and PlaceholderAPI-Expansion to use PlaceholderAPI anywhere MiniPlaceholders works, with more options for how placeholders are interpreted.

To get backend placeholders on Velocity, use MiniPlaceholders, the PAPI-Expansion, and PAPIProxyBridge.