🧩Placeholders

πŸ“„ Introduction

Placeholders allow you to display dynamic information about teams, players, and other aspects of your plugin in a variety of formats, such as messages or titles. These placeholders can be used in various configuration files to customize the server experience.

🧩 Supported Placeholders

Here is a list of the available placeholders you can use with the plugin, along with the format of the returned values:

βš™οΈ Placeholder
πŸ“„ Description
πŸ”„ Returned Format

%xteams_teamname_<player>%

Displays the team name of the specified player (replace <player> with the player’s name).

String: Name of the team (e.g., red)

%xteams_teamdisplayname_<player>%

Displays the display name of the team that the specified player is part of (replace <player>).

String: Display name of the team (e.g., &cThe Red Team)

%xteams_hasplayer_<player>:<team>%

Checks if the specified player is part of the given team (returns "true" or "false").

Boolean: "true" or "false"

%xteams_playercount_<team>%

Shows the number of players in the specified team.

Integer: Number of players (e.g., 3)

%xteams_teammembers_<team>%

Lists the members of the specified team.

String: Comma-separated list of players (e.g., player1, player2, player3)

%xteams_teams%

Lists all teams currently registered in the plugin.

String: Comma-separated list of team names (e.g., Red, Blue, Yellow)

%xteams_teamexists_<team>%

Checks if the specified team exists (returns "true" or "false").

Boolean: "true" or "false"

%xteams_teampriority_<team>%

Displays the priority of the specified team.

Integer: Priority number (e.g., 1, 5)

❓ How to Use These Placeholders

To use these placeholders, simply insert them in the appropriate places in supported configuration files like messages.yml or config.yml. For example, if you want to show a player's team name in a message, you can use the %xteams_teamname_<player>% placeholder.

πŸ’‘ Example of Use in a Server

If you have PlaceholderAPI installed, these placeholders will automatically be replaced by the corresponding values when players see messages or titles that use them.

  • %xteams_teamname_<player>% will replace the placeholder with the name of the team the player belongs to.

  • %xteams_teampriority_<team>% will show the priority of the given team.

βš™οΈ Example Configuration

team_join_message: "Welcome to team %xteams_teamname_%player%, Display Name: %xteams_teamdisplayname_%player%"
team_info_message: "Team %xteams_teamname_<team>%, Members: %xteams_teammembers_<team>%, Player Count: %xteams_playercount_<team>%"
team_exists_message: "Does Team %xteams_teamexists_<team>% exist? %xteams_teamexists_<team>%"

πŸ”— Compatibility with PlaceholderAPI

If PlaceholderAPI is installed on your server, the plugin integrates directly with it. You do not need to do any extra configuration to make these placeholders work. Just add them to your messages, titles, or any other display format, and the plugin will handle the rest.

Last updated