Skip to content

PlaceholderAPI

iAmForyy_ edited this page May 11, 2026 · 8 revisions

PlaceholderAPI

ByteClans provides a set of placeholders via PlaceholderAPI.
Make sure PlaceholderAPI is installed and that the server has been restarted at least once after installing ByteClans.


Clan Placeholders

These placeholders return information about the clan the player belongs to.
If the player is not in a clan, they return an empty string.

Placeholder Description Example
%byteclans_clan_name% Internal clan name (lowercase, immutable) bytephoria
%byteclans_clan_display% Clan display name (supports color formatting) &aBytephoria
%byteclans_clan_owner% Owner's username Steve
%byteclans_clan_members% Current number of members 8
%byteclans_clan_max-members% Maximum member limit 20
%byteclans_clan_max-allies% Maximum allies limit 5
%byteclans_clan_max-enemies% Maximum enemies limit 5
%byteclans_clan_kills% Total clan kills 142
%byteclans_clan_deaths% Total clan deaths 57
%byteclans_clan_kdr% Kill/death ratio (2 decimal places) 2.49
%byteclans_clan_kills-streak% Current kill streak 12
%byteclans_clan_pvp-mode% Current PvP mode NO_DAMAGE
%byteclans_clan_invite-state% Current invite state INVITE_ONLY
%byteclans_clan_created-at% Clan creation date 17/03/2026
%byteclans_clan_points% Total clan points 0
%byteclans_clan_display-cooldown% Whether the clan is on display cooldown true

Member Placeholders

These placeholders return information about the player's membership within their clan.
If the player is not in a clan, they return an empty string.

Placeholder Description Example
%byteclans_member_role% Role ID as defined in roles.yml co-owner
%byteclans_member_role-display% Role display name (supports color formatting) &6Co-Owner
%byteclans_member_join-date% Date the player joined the clan 17/03/2026
%byteclans_member_kills% Total player kills while being in the clan 25
%byteclans_member_deaths% Total player deaths while being in the clan 8
%byteclans_member_kdr% Player kill/death ratio while being in the clan 3.12
%byteclans_member_last-seen% Last time the player was online 17/03/2026 21:30:00
%byteclans_member_chat-mode% Player's current chat mode CLAN
%byteclans_member_has-permission_<CLAN_ACTION>% Checks whether the member has the specified clan action permission true

Notes

  • %byteclans_clan_pvp-mode% possible values: NO_DAMAGE, SAFE_DAMAGE, FRIENDLY_FIRE
  • %byteclans_clan_invite-state% possible values: OPENED, CLOSED, INVITE_ONLY
  • %byteclans_member_chat-mode% possible values: PUBLIC, CLAN
  • Clan actions: ClanAction.java

Clone this wiki locally