ByteClansLeaderboard v1.3.0

Requires ByteClans (Free) or ZelTeams (Paid) or UltimateClans (Paid), Java 21+ & Paper 1.20.4+​

Click to expand...

If you need help, join the Discord server.​

What is ByteClans Leaderboards?​

Key Features​

• Multiple Time Periods: Track clan performance across daily, weekly, monthly, and all-time leaderboards.
• Database Support: Fully supports H2, MySQL, and MariaDB for flexible and scalable data storage options.
• Extended Compatibility: Supports ByteClans, and limited integration with ZelTeams and UltimateClans (kills, deaths, and calculated KDR only due to API limitations).
• Comprehensive Statistics: Leaderboards are available for kills, deaths, KDR (kill/death ratio), points, and killstreak.
• Automatic Updates: Statistics are updated in real time as players participate in combat.
• Reset System: Period-based leaderboards reset automatically (daily, weekly, monthly), keeping competition fresh and active.
• PlaceholderAPI Support: Easily display leaderboard data using placeholders for positions, values, and clan information.
• Hologram Ready: Designed to work perfectly with hologram plugins for in-game leaderboard displays.
• Lightweight & Optimized: Built with performance in mind — no unnecessary overhead or impact on server TPS.
• Seamless Integration: Fully compatible with ByteClans’ API and data system.

Available Leaderboards​

• Kills: Total kills achieved by the clan.
• Deaths: Total deaths recorded.
• KDR: Kill/Death ratio for performance efficiency.
• Points: Custom scoring system based on clan activity.
• Killstreak: Highest kill streak achieved.

Installation​

1. Download the ByteClans Leaderboards addon.
2. Place the .jar file into your server's plugins/ folder.
3. Make sure ByteClans (or any clan plugin dependency) is installed and running.
4. Start or restart your server.
5. Configure leaderboard settings if needed.

# ─── TOP LEADERBOARD ───────────────────────────────────────────────────────────
# Format: %byteclansleaderboard_top_<type><period><position>_<field>%
#
# Types: kills | deaths | kdr | points | killstreak
# Periods: daily | weekly | monthly | all-time
# Positions: 1–10
# Fields: name | display-name | owner_id | owner_name | members | kills | deaths | kdr | points | killstreak | rank
#
# Returns the configured empty value if the position is unoccupied.

%byteclansleaderboard_top_kills_daily_1_name% → Clan name at #1 in daily kills
%byteclansleaderboard_top_kills_daily_1_display-name%→ Clan display name at #1 in daily kills
%byteclansleaderboard_top_kills_daily_1_owner_name% → Owner name of the clan at #1
%byteclansleaderboard_top_kills_daily_1_owner_id% → Owner uuid of the clan at #1
%byteclansleaderboard_top_kills_daily_1_members% → Member count of the clan at #1
%byteclansleaderboard_top_kills_daily_1_kills% → Total kills of the clan at #1
%byteclansleaderboard_top_kills_daily_1_deaths% → Total deaths of the clan at #1
%byteclansleaderboard_top_kills_daily_1_kdr% → KDR of the clan at #1 (2 decimal places)
%byteclansleaderboard_top_kills_daily_1_points% → Points of the clan at #1
%byteclansleaderboard_top_kills_daily_1_killstreak% → Best kill streak of the clan at #1
%byteclansleaderboard_top_kills_daily_1_rank% → Rank position (#1)

# The same structure applies to all type + period + position combinations:
# types: kills | deaths | kdr | points | killstreak
# periods: daily | weekly | monthly | all-time
# positions: 1 – 10

# ─── RESET TIME ────────────────────────────────────────────────────────────────
# Time remaining until the next period reset.
# Format is configurable in config.yml (default: "{d}d {h}h {m}m").
# all-time always returns "∞" as it never resets.

%byteclansleaderboard_reset_daily% → Time left until the daily leaderboard resets
%byteclansleaderboard_reset_weekly% → Time left until the weekly leaderboard resets
%byteclansleaderboard_reset_monthly% → Time left until the monthly leaderboard resets
%byteclansleaderboard_reset_all-time% → Always returns ∞

# ─── PLAYER CLAN RANK ──────────────────────────────────────────────────────────
# Current rank of the player's clan in the given leaderboard.
# Returns the configured empty value if the player has no clan
# or if their clan has no data for that period yet.

%byteclansleaderboard_clan_rank_kills_daily% → Player's clan rank in daily kills
%byteclansleaderboard_clan_rank_kills_weekly% → Player's clan rank in weekly kills
%byteclansleaderboard_clan_rank_kills_monthly% → Player's clan rank in monthly kills
%byteclansleaderboard_clan_rank_kills_all-time% → Player's clan rank in all-time kills

%byteclansleaderboard_clan_rank_deaths_daily% → Player's clan rank in daily deaths
%byteclansleaderboard_clan_rank_deaths_weekly% → Player's clan rank in weekly deaths
%byteclansleaderboard_clan_rank_deaths_monthly% → Player's clan rank in monthly deaths
%byteclansleaderboard_clan_rank_deaths_all-time% → Player's clan rank in all-time deaths

%byteclansleaderboard_clan_rank_kdr_daily% → Player's clan rank in daily KDR
%byteclansleaderboard_clan_rank_kdr_weekly% → Player's clan rank in weekly KDR
%byteclansleaderboard_clan_rank_kdr_monthly% → Player's clan rank in monthly KDR
%byteclansleaderboard_clan_rank_kdr_all-time% → Player's clan rank in all-time KDR

%byteclansleaderboard_clan_rank_points_daily% → Player's clan rank in daily points
%byteclansleaderboard_clan_rank_points_weekly% → Player's clan rank in weekly points
%byteclansleaderboard_clan_rank_points_monthly% → Player's clan rank in monthly points
%byteclansleaderboard_clan_rank_points_all-time% → Player's clan rank in all-time points

%byteclansleaderboard_clan_rank_killstreak_daily% → Player's clan rank in daily kill streak
%byteclansleaderboard_clan_rank_killstreak_weekly% → Player's clan rank in weekly kill streak
%byteclansleaderboard_clan_rank_killstreak_monthly% → Player's clan rank in monthly kill streak
%byteclansleaderboard_clan_rank_killstreak_all-time% → Player's clan rank in all-time kill streak

Click to expand...