> ## Documentation Index
> Fetch the complete documentation index at: https://docs.razebot.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Leaderboards & Live Leaderboards

> View top server contributors or setup automated live-updating leaderboard embeds.

# Leaderboard System

<Badge variant="elite">Tier 1: Elite</Badge>

> Celebrate your most active community members with on-demand ranked leaderboards and automated, self-updating live leaderboard embeds.

***

## Commands Overview

| Command            | Aliases                              | Syntax                                 | Description                                                    | Permissions   |
| :----------------- | :----------------------------------- | :------------------------------------- | :------------------------------------------------------------- | :------------ |
| `.leaderboard`     | `lb`                                 | `.leaderboard <subcommand>`            | View ranked user leaderboards for messages, voice, or invites. | None          |
| `.liveleaderboard` | `live`, `livelb`, `liveleaderboards` | `.liveleaderboard <subcommand> [args]` | Setup automated real-time updating leaderboard channels.       | Administrator |

***

## On-Demand Leaderboards

### leaderboard

View top ranked members across all-time, daily, or weekly timeframes.

| Subcommand       | Aliases | Description                         | Example                       |
| :--------------- | :------ | :---------------------------------- | :---------------------------- |
| `messages`       | `m`     | All-time message leaderboard        | `.leaderboard messages`       |
| `dailymessages`  | `dm`    | Daily message leaderboard           | `.leaderboard dailymessages`  |
| `weeklymessages` | `wm`    | Weekly message leaderboard          | `.leaderboard weeklymessages` |
| `voice`          | `vc`    | All-time voice duration leaderboard | `.leaderboard voice`          |
| `dailyvoice`     | `dv`    | Daily voice leaderboard             | `.leaderboard dailyvoice`     |
| `weeklyvoice`    | `wv`    | Weekly voice leaderboard            | `.leaderboard weeklyvoice`    |
| `invites`        | `i`     | Server invite leaderboard           | `.leaderboard invites`        |

<Tabs>
  <Tab title="Messages">
    ```bash theme={null} theme={null}
    .leaderboard messages
    .leaderboard dailymessages
    .leaderboard weeklymessages
    ```
  </Tab>

  <Tab title="Voice">
    ```bash theme={null} theme={null}
    .leaderboard voice
    .leaderboard dailyvoice
    .leaderboard weeklyvoice
    ```
  </Tab>

  <Tab title="Invites">
    ```bash theme={null} theme={null}
    .leaderboard invites
    ```
  </Tab>
</Tabs>

* **Aliases**: `lb`
* **User Permissions**: None

***

## Live Updating Leaderboards

### liveleaderboard

Deploy an automated embed in a dedicated channel that continuously refreshes top member rankings in real-time.

| Subcommand | Syntax                                                | Description                                  | Example                                        |
| :--------- | :---------------------------------------------------- | :------------------------------------------- | :--------------------------------------------- |
| `setup`    | `.liveleaderboard setup <type> <#channel\|channelId>` | Creates a live updating leaderboard embed    | `.liveleaderboard setup messages #leaderboard` |
| `reset`    | `.liveleaderboard reset`                              | Removes live leaderboard setup               | `.liveleaderboard reset`                       |
| `config`   | `.liveleaderboard config`                             | Views active live leaderboard configurations | `.liveleaderboard config`                      |

#### Supported Live Leaderboard Types:

* `messages` — All-time top message senders
* `dailymessages` — Top daily message senders
* `weeklymessages` — Top weekly message senders
* `voice` — All-time top voice channel members
* `dailyvoice` — Top daily voice channel members
* `weeklyvoice` — Top weekly voice channel members
* `invites` — Top server inviters
* `giveaways` — Top giveaway winners / hosts

<Tabs>
  <Tab title="Setup Chat Leaderboard">
    ```bash theme={null} theme={null}
    .liveleaderboard setup messages #chat-rankings
    ```
  </Tab>

  <Tab title="Setup Voice Leaderboard">
    ```bash theme={null} theme={null}
    .liveleaderboard setup voice #voice-rankings
    ```
  </Tab>

  <Tab title="View Configuration">
    ```bash theme={null} theme={null}
    .liveleaderboard config
    ```
  </Tab>
</Tabs>
