> For the complete documentation index, see [llms.txt](https://competitions.gitbook.io/competition-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://competitions.gitbook.io/competition-docs/games/leaderboard.md).

# Leaderboard

### Visual Modes

These modes offer a different visual to the standard table list

<div><figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FppUNGhpvbDwj5UfiDtRY%2Fracestadium.gif?alt=media&amp;token=aa021001-6528-4172-85d4-52f63ce8cec6" alt=""><figcaption></figcaption></figure> <figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2Fl9hnjedvSvA02ilBrWL2%2FJungleGif.gif?alt=media&amp;token=85f95687-c002-4a89-829c-cc35c84aac36" alt=""><figcaption></figcaption></figure> <figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FXVKkQEHzHL4IEeZdWua1%2Fimage.png?alt=media&amp;token=b8ffacc0-d89e-431f-b11a-f70b462a1af5" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FRFJgIjVFxAUbANVPZmDC%2Fimage.png?alt=media&amp;token=459597ba-b3a3-44b5-8bfe-5f999f871d3a" alt=""><figcaption></figcaption></figure> <figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FLcOkCpx6SN4V37ARd1HW%2Fimage.png?alt=media&amp;token=f9c9407b-4ace-4200-8c8d-d189115b0c21" alt=""><figcaption></figcaption></figure> <figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2F5c52vERqv7fiIi1eBSlK%2Fimage.png?alt=media&amp;token=b0e30179-1333-426a-a353-32e62ce2c310" alt=""><figcaption></figcaption></figure></div>

### Leaderboard Settings

The Leaderboard plugs in with Instant wins to create a leaderboard podium. It can be intervalled by weekly or daily, aswell as one leaderboard for the entire duration of a competition.\
\
Each Leaderboard is set per competition, so you can have a leaderboard competition, it is not a global leaderboard.

Below are the settings that are shown when creating a competition, you can setup any type of game mode aslong as you have instant prizes enabled.

{% hint style="success" %}
The leaderboard options can be found when setting up a new competition under the description
{% endhint %}

### Game Modes

{% tabs %}
{% tab title="Win Mode" %}
Counts how many times a customer has won an instant, this is used to tally the scoreboard, those who have won more instant wins will be at the top
{% endtab %}

{% tab title="Points Mode" %}
Add Pts or Points to your instant prize names such as "50 Points" it will tally up the points for each customer and put them on the leaderboard
{% endtab %}

{% tab title="Crown Clash" %}
An exclusive game mode where people can wear the Crown, steal it and compete to hold it the longest. The one who holds it for the longest overall wins.\
\ <mark style="color:$success;">You must put "Steal" and/or "Crown" in any instant win title, this allows someone to hold the crown and start the timer!</mark>\
\
**For example "Steal it", "Hold the Crown", "Steal the Crown"**\
\
Other keywords you can use instead of Crown or Steal are: Throne, King, Queen\
\
For example\
"Sit on the Throne"\
"All Hail the new King"\
"Long live with Queen"
{% endtab %}
{% endtabs %}

### Setting up a Leaderboard

You can set the game mode, time the leaderboard resets and chooses a winner and the interval, these settings are found when creating a new competition under the description box

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FBWkFKdZ7dIQZXwHqm2NM%2Fimage.png?alt=media&amp;token=e8979ea7-cc1d-4784-9001-2ec6436031c2" alt=""><figcaption></figcaption></figure>

For a leaderboard that lasts the entire duration of the competition and does not reset, tick the "Set all time visuals" option, which will disable intervals and have an all-time leaderboard.

{% hint style="warning" %}
If you have the Payout feature be cautious when setting up instant wins that have no cash or physical reward
{% endhint %}

**If you have the Payouts feature on your website, please make sure you click "Non Payable" on any instants that do not have a non-digital reward otherwise they will show up on the Payouts section for winners**

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FFIocE1fNHyy3c4B03eMu%2Fimage.png?alt=media&amp;token=9122cc5a-796e-47bf-84ff-0d1f067ad6cd" alt=""><figcaption></figcaption></figure>

### Frontend View for Customers

Here is an example of a basic leaderboard with podiums that is shown on the frontend.

{% hint style="success" icon="brain-circuit" %}
Tie breakers where customers have the same points will have a higher position based on how long they've held the score. Therefore someone who has held 8 points for a few hours, will be at a higher position than someone who held 8 points for a few minutes
{% endhint %}

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FLhfnR5XyZg1GvTDwJgNW%2Fimage.png?alt=media&amp;token=fc143135-3ead-473b-9466-63e790487b11" alt=""><figcaption></figcaption></figure>

### How do I reward winners?

You can manually reward winners, typically with wallet credit. For admins you will be able to see the date ranges which you can click to see the timeline of the leaderboard at that point.

Here is an example:

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FTcay6ayqFIwLRsYU8dHW%2Fimage.png?alt=media&amp;token=295c9532-b8c3-4c4a-84d8-bd271d078207" alt=""><figcaption></figcaption></figure>

### Automatic Wallet Credit

{% hint style="success" %}
This also works with [Wallet Cash](/competition-docs/instant-prizes/wallet-cash-as-an-instant.md) if you have it enabled
{% endhint %}

With this feature you can optionally run automatic wallet rewards

First you need to select the Queue for approval mode on the Reward tab, after 3 competitions have been run on this mode you will be able to unlock the automatic mode.

Set the Wallet Credit you want to reward for each position on interval resets

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2F502XVwYX4t01FsCylTYu%2Fimage.png?alt=media&amp;token=64f4dbf2-b278-4d17-924e-88d3a21431a2" alt=""><figcaption></figcaption></figure>

On the Payouts tab you will find a report of the current stats & a ledger of everyone paid, if you're in the Queue for approval mode you will need to manually approve them which will automatically go to their wallet credit.

{% hint style="success" %}
We advise you to check the ledger against your previous process to make sure it is accurate before Approving winners, 3 competitions need to be successfully approved to unlock the automatic mode
{% endhint %}

<figure><img src="https://3744898343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmZQfjJYplU4Sw9Oe8b0%2Fuploads%2FfR4F4u0ekUEksObY00ex%2Fimage.png?alt=media&amp;token=4393683e-d7b0-4f0d-8458-02ca3a5403f3" alt=""><figcaption></figcaption></figure>

Automatic mode will skip the approval step and automatically reward them roughly 5 minutes after the interval reset. If you use Automatic mode please make sure your configuration is correct.

{% hint style="info" %}
If you change the Interval time to a time on the same day this will not cause a duplicate reward as we check per date not date + time
{% endhint %}
