PlaceholderAPI Support

📝 Placeholders Overview

🎨 Introduction

NameGradient provides a wide variety of placeholders for PlaceholderAPI that allow you to display names, gradients, and color styles in different formats. All placeholders begin with %namegradient_.

Requirement: You need to have PlaceholderAPI installed on your server.

💬 Chat placeholders

Placeholder
Description

%namegradient_gradient_chat_id%

Returns the ID of the chat gradient equipped by the player (returns “” if none is equipped).

%namegradient_gradient_chat_patterns%

Displays the hexadecimal colors that make up the chat gradient.

%namegradient_gradient_chat_style%

Displays the type of style applied (bold, italic, etc.).

Possible outputs: BOLD, ITALIC, UNDERLINE, STRIKETHROUGH

%namegradient_gradient_chat_minimessage%

Returns the chat gradient format in MiniMessage syntax.

Example output:

<gradient:#FF0000:#00FF00:#0000FF>

👤 Name Placeholders

Placeholder
Description

%namegradient_gradient_name%

It will give the name of the player formatted with the gradient (ideal for use in chat or tab).

%namegradient_gradient_name_id%

Gets the identifier of the currently equipped gradient for the name.

%namegradient_gradient_name_patterns%

Displays the hexadecimal colors that make up the name gradient.

%namegradient_gradient_name_style%

Displays the type of style applied (bold, italic, etc.).

Possible outputs: BOLD, ITALIC, UNDERLINE, STRIKETHROUGH

%namegradient_gradient_name_minimessage%

Returns the player's name formatted specifically for MiniMessage, ideal for plugins such as TAB or LuckPerms.

%namegradient_text_gradient_[#RRGGBB,#RRGGBB]_[TEXT]_[STYLE]%

It will format your text with the colors and stylo assigned to it.

%namegradient_cooldown_custom%

Cooldown before you can change the custom gradient again.

⚙️ Advanced placeholder

Placeholder
Description

%namegradient_gradient_name_HEX%

With this placeholder you can get your name in HEX format &#RRGGBB

%namegradient_gradient_name_LEGACY_HEX%

With this placeholder you can get your name in HEX format &x&R&R&G&G&B&B

%namegradient_gradient_name_ANGLE_BRACKETS%

With this placeholder you can get your name in HEX format <#RRGGBB>

%namegradient_gradient_name_STANDARD%

With this placeholder you can get your name in HEX format #RRGGBB

Placeholder
Description

%namegradient_gradient_name_patterns_HEX%

With this placeholder, you can get the hex values of the equipped gradient in HEX &#RRGGBB format.

%namegradient_gradient_name_patterns_LEGACY_HEX%

With this placeholder, you can get the hex values of the equipped gradient in HEX format &x&R&R&G&G&B&B

%namegradient_gradient_name_patterns_ANGLE_BRACKETS%

With this placeholder, you can get the hex values of the equipped gradient in HEX format <#RRGGBB>

%namegradient_gradient_name_patterns_STANDARD%

With this placeholder, you can get the hex values of the equipped gradient in HEX format #RRGGBB

🧾 Placeholder Fields Overview

Placeholder Field
Description

placeholder

Displays the name or label of the requirement (e.g. "Kills", "Playtime").

condition

The condition operator required to fulfill the requirement (e.g. >=, ==).

value

The target value that must be reached (e.g. 100, 3600).

success

Message shown if the requirement is completed.

fail

Message shown if the requirement is not completed.

completed

Returns true if the requirement has been completed, false otherwise.

lore

A pre-formatted visual line that uses success or fail based on the completion status.


📌 Placeholder Context Types

Context Prefix
Purpose

requirements_...

Shows data for a specific gradient and requirement, regardless of what is equipped.

current_requirements_...

Shows data for the currently equipped gradient and its requirements.


✅ Example: Using a Requirement Placeholder

Assume you have a NAME type gradient called FireTrail, with a requirement to have at least 100 kills:

Placeholder
Example Value

%namegradient_requirements_NAME_FireTrail_1_placeholder%

Kills

%namegradient_requirements_NAME_FireTrail_1_condition%

>=

%namegradient_requirements_NAME_FireTrail_1_value%

100

%namegradient_requirements_NAME_FireTrail_1_success%

✔ Requirement complete!

%namegradient_requirements_NAME_FireTrail_1_fail%

✖ You need more kills.

%namegradient_requirements_NAME_FireTrail_1_completed%

true (if player has ≥ 100 kills)

%namegradient_requirements_NAME_FireTrail_1_lore%

✔ Requirement complete! (if completed) or ✖ You need more kills. (if not)

You can use %namegradient_current_requirements_NAME_*% to automatically refer to the currently equipped gradient instead of specifying one.

Last updated