SkLeaderboards

A Skript addon designed to provide efficient, lag-free leaderboards with direct Skript variable and player stats support, all without placeholders.

Why SkLeaderboards?

In Skript, holographic leaderboards are very inefficient and laggy. Scripts typically rely on console commands that directly update a hologram. Constantly updating these holograms, especially many at a time can cause large amounts of lag on a server.

SkLeaderboards is built to solve this problem. The plugin allows for simple configuration of leaderboards directly in Skript, with updating the holograms fully left to the plugin. Furthermore, the plugin only updates the hologram when a displayed value needs an update, removing useless updates that make no change and further improving efficiency.

SkLeaderboard directly reads Skript variables, player statistics from data files and economy data directly from EssentialsX.

With SkLeaderboards, the host of the holograms can also be easily edited by one line and can be different for every single leaderboard.

Supported Holgram Hosts:

• Text Displays (Vanilla)
• FancyHolograms
• DecentHolograms

Requirements

• Paper 1.21.x - 26.x
• Skript 2.14.x - 2.17.x
• Java 21+

Installation

1. Download the latest release from Modrinth.
2. Download the latest Skript release.
3. Download your preferred optional dependancies: FancyHolograms, DecentHolograms, EssentialsX.
4. Drag all downloaded .jars into your server's \plugins folder and restart the server.
5. Create a script and register a leaderboard (Example snippets below).
6. Create the leaderboard hologram using /lb create <id>.

Usage

Syntax	Aliases	Required?	Hosts	Accepted Values & Defaults
title	header	Yes	All	Quoted text. \n makes a new line.
value	variable	Yes	All	{list::*}, kills, deaths, playtime or balance (requires EssentialsX).
host	display	No	All	text display (default), fancyholograms or decentholograms.
size	limit, entries	No	All	1 to 100. Default 10.
order	sort, sort order	No	All	descending (default) or ascending.
refresh	interval, refresh interval, update interval	No	All	A timespan. 1 second minimum. Default 30 seconds.
format	line format	No	All	Quoted. Uses %position%, %name% and %value%. Default #%position% %name% - %value%.
first format to tenth format	1st format to 10th format	No	All	Quoted. Overrides format for that one rank.
footer	bottom	No	All	Quoted. %refresh% shows the refresh time. No footer by default.
shadow	text shadow	No	Text display and FancyHolograms	true or false.
billboard	rotation, facing	No	Text display and FancyHolograms	fixed, vertical, horizontal or center. Default vertical of text displays.
background	background colour, background color	No	Text display and FancyHolograms	none, default, "#RRGGBB" or "#RRGGBBAA". Default none on text displays.
view distance	visibility distance, render distance, view range, range, distance	No	All	1 to 512 blocks.

Command	Description
/lb create <id>	Create a leaderboard hologram that has been registered in a script
/lb delete <id>	Delete a leaderboard hologram
/lb move <id>	Move a leaderboard hologram that has already been created
/lb refresh <all / id>	Refresh all or a particular leaderboard hologram(s)
/lb info <id>	Display info about an existing leaderboard
/lb list	List all existing leaderboards and their locations

Snippets

register a new leaderboard with id "balanceLB":
    title: "&a&lBALANCE LEADERBOARD"
    value: balance
    host: fancy holograms
    size: 10
    refresh: 10 minutes
    format: "&7#%position% &f%name% &8- <#4FF522>$%value%"
    1st format: "&e#%position% &f%name% &8- <#4FF522>$%value%"
    2nd format: "&f#%position% &f%name% &8- <#4FF522>$%value%"
    3rd format: "&6#%position% &f%name% &8- <#4FF522>$%value%"
    footer: "&7Updates every %refresh%"
    shadow: false
    billboard: vertical
    background: none
    sort: descending
    view distance: 20

register a new leaderboard with id "testLB":
    title: "&c&lTEST LEADERBOARD&r"
    value: {variable::*}
    host: text display
    size: 10
    refresh: 60 seconds
    format: "&7#%position% &f%name% &8- <#4FF522>%value%"
    1st format: "&e#%position% &f%name% &8- <#4FF522>%value%"
    2nd format: "&f#%position% &f%name% &8- <#4FF522>%value%"
    3rd format: "&6#%position% &f%name% &8- <#4FF522>%value%"
    footer: "&7Updates every %refresh%"

Support

• Discord
• GitHub Issues Tracker