Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanLeaderboard
ClanLeaderboard practical usage guide#
ClanLeaderboard adds persistent clan leaderboards displayed through supported stand/skull/sign/hologram-style representations with admin edit/update flow. This guide focuses on the actual administrator and player workflow: what to set up first, how to test it in-game, and what to check before enabling it for everyone.
How the feature works#
In normal use, the feature follows this flow: 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.
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.
Administrator setup checklist#
- 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.
Commands and GUI access#
Use the command examples in the workflow above and open the Commands page in the sidebar for the complete configured command tree. Command labels can be changed in commands.yml, so the Wiki keeps the player-facing examples separate from the raw message templates.
Configuration areas#
Config—date_format_short,Leaderboard,Storage
Changing settings safely#
- Back up the component configuration and persistent data before changing a live server.
- Change one feature area at a time.
- Reload only if the component documents reload as safe; otherwise restart the server.
- Test with a non-OP account that has exactly the intended clan role/permission.
- Watch the console from the first relevant warning/error, not only the final stack trace.
- On multiserver networks, repeat the check on every node and confirm shared storage/sync settings match.