> 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="/files/NBTolXECxp4iOTd55f9a" alt=""><figcaption></figcaption></figure> <figure><img src="/files/TKKgX4pZgxviwZwv1v6y" 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="/files/I1oZOwuiNyiNcnb6zuMh" 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="/files/yiku4YlDKI6Yt2zHeCAS" alt=""><figcaption></figcaption></figure>

### Frontend View for Customers

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

<figure><img src="/files/wZUMJ0m6zWZa5GRF6z73" alt=""><figcaption></figcaption></figure>

### How do I reward winners?

You will need to 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.&#x20;

Here is an example:

<figure><img src="/files/R97Hln2fkwWReOK5VbRn" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://competitions.gitbook.io/competition-docs/games/leaderboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.