How To Create A Leaderboard In Roblox

Roblox has a built-in leaderboard system that lets you display player information like scores, currency, or the fastest time in a race.

Leaderboard Setup

Whenever a player enters the game, they should be added to the leaderboard. This can be done as follows:

Create a new Script within ServerScriptService.

In the script, connect a function to the Players/PlayerAdded|PlayerAdded event.

local Players = game:GetService("Players")            local function leaderboardSetup(player)            end            -- Connect the "leaderboardSetup()" function to the "PlayerAdded" event            Players.PlayerAdded:Connect(leaderboardSetup)

Inside the connected function, create a new Folder instance, name it leaderstats, and parent it to the player.

local Players = game:GetService("Players")  local function leaderboardSetup(player)            local leaderstats = Instance.new("Folder")            leaderstats.Name = "leaderstats"            leaderstats.Parent = player            end  -- Connect the "leaderboardSetup()" function to the "PlayerAdded" event Players.PlayerAdded:Connect(leaderboardSetup)

Adding Stats

Leaderboards use value type objects to store and display player stats. This script will show a player's gold using an IntValue, a placeholder for an integer.

In the leaderboardSetup() function, add the highlighted code:

local Players = game:GetService("Players")  local function leaderboardSetup(player) 	local leaderstats = Instance.new("Folder") 	leaderstats.Name = "leaderstats" 	leaderstats.Parent = player            local gold = Instance.new("IntValue")            gold.Name = "Gold"            gold.Value = 0            gold.Parent = leaderstats            end  -- Connect the "leaderboardSetup()" function to the "PlayerAdded" event Players.PlayerAdded:Connect(leaderboardSetup)

These lines accomplish the following:

An IntValue instance is created.
The instance's Instance/Name|Name is set to Gold. This is exactly how the stat will appear on the in-game leaderboard.

The stat's initial IntValue/Value|Value is set to 0. This can be set to any value you wish, including a value stored in a /articles/saving data introduction|data store if you're implementing persistent leaderboards.

The instance is parented to the leaderstats folder which adds it to the leaderboard. When players enter the game, their names will appear on the board.

Updating Stats

To update a player's leaderboard stat, simply change the Value property of that stat within their leaderstats folder. For example, the following Script can be attached to any pickup object to increase the Gold stat of whichever player collects it.

local Players = game:GetService("Players")  local goldChunk = script.Parent  local function onPartTouch(otherPart) 	local partParent = otherPart.Parent 	local humanoid = partParent:FindFirstChildWhichIsA("Humanoid") 	if humanoid then 		-- Destroy the pickup 		goldChunk:Destroy() 		-- Update the player's leaderboard stat 		local player = Players:GetPlayerFromCharacter(partParent)            local leaderstats = player.leaderstats            local goldStat = leaderstats and leaderstats:FindFirstChild("Gold")            if goldStat then            goldStat.Value = goldStat.Value + 10            end            end end goldChunk.Touched:Connect(onPartTouch)

Hiding the Leaderboard

If you ever want to hide the leaderboard, such as on a menu screen or during a cutscene, place a LocalScript within StarterGui or StarterPlayerScripts containing a call to StarterGui/SetCoreGuiEnabled|StarterGui:SetCoreGuiEnabled():

local StarterGui = game:GetService("StarterGui")            StarterGui:SetCoreGuiEnabled(Enum.CoreGuiType.PlayerList, false)