Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanLeaderboard

ClanLeaderboard#

ClanLeaderboard adds persistent clan leaderboards displayed through supported stand/skull/sign/hologram-style representations with admin edit/update flow. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.

Compatibility#

Component version: 4.0.1
Documentation release: 2026.09.5
Minimum UltimateClans version: 9.0.0

What you can do with it#

Create a leaderboard with the admin command at the intended location
Use edit mode to adjust/configure the board and select the desired display action/type
Run update after changing ranking settings or display data
Test teleport/view and server restart persistence

How it works#

What the leaderboard displays#

ClanLeaderboard reads clan statistics/ranking data and exposes them through configured leaderboard views/holograms. The manager/storage/hologram layers are separate: storage/query determines the ranking data, while hologram configuration controls where and how that ranking is presented.

Create one leaderboard with a small top-N size first, verify sort order against known clan data, then add additional boards/locations. If a display is stale, determine whether the query/result is wrong or only the hologram refresh is stale.

First setup#

Before enabling the feature for players, review these installed files:

commands.yml
config.yml
language/Lang_EN.yml
polymart.yml

Recommended in-game workflow#

Create a leaderboard with the admin command at the intended location.
Use edit mode to adjust/configure the board and select the desired display action/type.
Run update after changing ranking settings or display data.
Test teleport/view and server restart persistence.

Useful command entry points#

/clanleaderboard help
/clanleaderboard reload
/clanleaderboard create
/clanleaderboard editmode
/clanleaderboard update
/clanleaderboard delete
/clanleaderboard tp

See Commands in the sidebar for the full command reference and configured aliases/permissions.

What administrators should configure#

Configure storage before creating many boards; changing database type later requires migration.
Display/hologram implementations must be available for the chosen representation.
Use a stable update interval appropriate to the number of boards.

Configuration map#

config.yml — Config (date_format_short, Leaderboard, Storage)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

Before going live#

Back up the component data/configuration.
Start the server and confirm the component is detected without startup errors.
Test with a non-OP player and the lowest clan role that should have access.
Exercise the complete flow once, including the failure/deny path, not only the happy path.
Restart the server and verify that persistent state survives.
If the network is multiserver, repeat the test from a second node and verify storage/synchronization.

Troubleshooting quick reference#

Symptom	Likely cause	What to check
Board exists but shows no ranking	Data source/category has no eligible clans or update has not run	Check ranking source and force the supported update.
Hologram/stand is missing	Required display implementation failed or entity was removed	Check hologram/entity provider and recreate/update only after confirming integration.
Board moves or duplicates after restart	Saved location/entity state is inconsistent	Inspect persisted board record and avoid manual entity duplication.
Admin edit clicks do nothing	Edit mode is off or command permission missing	Enter edit mode and test with `clanleaderboard.admin`.

For a longer diagnostic flow, open the Troubleshooting page for this component.