# Leaderboards

{% hint style="warning" %}
J**ust added?** The bot starts tracking statistics as soon as it's invited to your server!
{% endhint %}

## Configure

1. Install Waya on your server by going to [get.waya.one](https://get.waya.one).
2. Type the `/leaderboards` or `/prompt leaderboards` command.
3. Set the config how you everything want. ([Need help?](https://lunish.nl/support))
4. Send the command.
5. 🎉 Done!

<figure><img src="/files/HBqV64iXq8AFH1040qf5" alt=""><figcaption><p>Waya message leaderboard</p></figcaption></figure>

{% content-ref url="/pages/94mGC9rGDZOL64FU94AI" %}
[/pace](/slash-commands/pace.md)
{% endcontent-ref %}

## Commands

There are 2 different commands to show a leaderboard.

* `/leaderboard <type> <..>` Shows a static leaderboard as a command reply.
* `/prompt leaderboard <type> <...........>` Shows an updating leaderboard, updates all 20 minutes.

## Features in words

With 🗨️ **message tracking,** the bot records all messages sent by a user, providing you with a clear understanding of their activity levels. Additionally, Waya also offers an 🔗 **invite leaderboard**, which displays the number of users a member has invited to the server. Last but not least, Waya 🔊 **tracks the time your users where connected to a voice chat**.

{% tabs %}
{% tab title="Messages" %}
Shows how many messages a user has sent since they/the bot joined the server.

<figure><img src="/files/7YMt1sjavVlJALWnnYlN" alt=""><figcaption><p>/leaderboard for member message count</p></figcaption></figure>

{% hint style="danger" %}
Bot is required to have `ViewChannel` permissions in every channel.
{% endhint %}
{% endtab %}

{% tab title="Voice" %}
Shows how long a user was in any voice channel with anyone else since they/the bot joined the server.

<figure><img src="/files/ovQ6p3CFDNQOrBBKQw5R" alt=""><figcaption><p>/leaderboard for member voice time</p></figcaption></figure>

{% hint style="danger" %}
Bot is required to have `ViewChannel` permissions in every voice channel.
{% endhint %}
{% endtab %}

{% tab title="Invites" %}
Shows the amount of members the user has invited since they/the bot joined the server.

<figure><img src="/files/nsiX22LJIw0vUQzBlAWa" alt=""><figcaption><p>/leaderboard for member invite count</p></figcaption></figure>

{% hint style="danger" %}
Bot is required to have `ManageGuild` permissions.
{% endhint %}
{% endtab %}
{% endtabs %}

Additionally, Waya's leaderboard feature **allows you to configure a reward role** for the top 3 most active users in message count and voice time. You can set this up in the **/config > miscs > leaderboards > roles** section of the bot.

<div align="left"><figure><img src="/files/yb0y7c4tDFGzJ2zojFKp" alt="" width="375"><figcaption><p>setup top 3 roles of a category</p></figcaption></figure></div>

## Config Options

### 😍 Display Type

Choose a style how the user should get displayed:

* User mention: @`Coffee Girl` (clickable)
* Username: `Coffee Girl`
* Nickname: `Luna`
* Tag: `Coffee Girl#8888` (soon to be `@coffee_girl`)
* Id: `821472922140803112`

### 🔥 Title

The title of the leaderboard embed.\
![](/files/lE9vmLOln5gmMB0wyMFN)

### 🖼️ Thumbnail

The small image on the right site of the embed. (1 : 1 ratio)\
![](/files/0QEdNoTpKIJIoVQAz9zW)

### 🖼️ Image

The big image bellows the top listed users.\
![](/files/SJIUCH65r7gqrWAttyrw)

### 🤏 Footer

Small text on the very bottom of the embed.\
![](/files/Aoi7mk5BJTeNIRM440PZ)

### 🎨 Color

Who would have guessed, the color on the left side of the embed.\ <img src="/files/K8UxHMP3cfyApKr1YhbY" alt="" data-size="original">

### ✨ Emote

The Emote used between the data and the user. You can use any default discord Emoji, most other Emojis and custom Emotes **from the same guild**.\
![](/files/82M2VEQb0A7MoOyeLWAJ)

### 💬 Quote

Chose if you want that intended quote thing (`>`) on the embed.\
![](/files/5uakG8MvF9agisNEXYZX)

### 🔢 Rank / Number / User

Chose the format you want to use for those texts inside of the embed.

* Bold (**example**)
* Italic (*example*)
* Underline (example)
* Code (`example`)
* None (example)

## Conclusion

In conclusion, Waya's leaderboard feature is an incredibly powerful and engaging tool for any Discord server. With its comprehensive tracking and customization options, it offers more than many paid alternatives on the market. From message tracking to invite leaderboards to voice time tracking, the leaderboard feature helps keep your server active and engaging for all members. And the best part? It's completely free. Give your server the boost it deserves with Waya's leaderboard feature.


---

# Agent Instructions: 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:

```
GET https://docs.waya.one/utilities/leaderboards.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.