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

# Booster Messages

> Automatically thank members who boost your server with customizable messages

## Overview

Booster messages automatically send thank you messages when members boost your server. You can configure multiple booster messages across different channels, use custom embeds, and ping boosters to show your appreciation.

<Info>
  Booster messages support both plain text with variables and custom embeds created with the embed builder.
</Info>

***

## Commands

<AccordionGroup>
  <Accordion title="booster add" icon="plus">
    Add a booster message or embed to a specific channel.

    <CodeGroup>
      ```bash Syntax theme={null}
      ~booster add <#channel> <message>
      ~booster add <#channel> <embed_name>
      ~booster add <#channel> <message> ping
      ~booster add <#channel> <embed_name> ping
      ```

      ```bash Examples theme={null}
      ~booster add #boosters Thanks for boosting, {user.mention}!
      ~booster add #general booster_embed
      ~booster add #thanks {user.mention} just boosted the server! ping
      ~boost add #announcements boost_thanks ping
      ```
    </CodeGroup>

    **Parameters:**

    * **#channel** — Channel where the booster message will be sent
    * **message** — Your booster message (supports variables)
    * **embed\_name** — Name of a saved embed from your embed builder
    * **ping** — Optional flag to mention the booster

    **Available Variables:**

    * `{user.mention}` — Mentions the booster
    * `{user.tag}` — User's full tag (name#0000)
    * `{user.id}` — User's ID
    * `{guild.name}` — Server name
    * `{guild.count}` — Total member count
    * `{guild.boost_count}` — Current boost count
    * `{guild.boost_tier}` — Server boost tier (0-3)
    * `{boost.goal}` — Boosts needed for next tier

    **Aliases:** `boost add`\
    **Permissions:** Manage Server

    <Tip>
      Add the word `ping` at the end of your command to mention boosters when they boost!
    </Tip>
  </Accordion>

  <Accordion title="booster list" icon="list">
    View all configured booster messages for your server.

    <CodeGroup>
      ```bash Syntax theme={null}
      ~booster list
      ```

      ```bash Examples theme={null}
      ~booster list
      ~boost list
      ```
    </CodeGroup>

    **What It Shows:**

    * Channel where each message is sent
    * Preview of text messages or embed names
    * Whether ping is enabled for each message
    * Numbered list for easy reference

    **Aliases:** `boost list`\
    **Permissions:** Manage Server
  </Accordion>

  <Accordion title="booster remove" icon="trash">
    Remove all booster messages from a specific channel.

    <CodeGroup>
      ```bash Syntax theme={null}
      ~booster remove <#channel>
      ```

      ```bash Examples theme={null}
      ~booster remove #boosters
      ~boost remove #general
      ```
    </CodeGroup>

    **What It Does:**

    * Removes ALL booster messages configured for the specified channel
    * Does not affect booster messages in other channels
    * Shows how many messages were removed

    **Aliases:** `boost remove`\
    **Permissions:** Manage Server
  </Accordion>

  <Accordion title="booster reset" icon="rotate-left">
    Reset all booster settings for your server.

    <CodeGroup>
      ```bash Syntax theme={null}
      ~booster reset
      ```

      ```bash Examples theme={null}
      ~booster reset
      ~boost reset
      ```
    </CodeGroup>

    **What It Does:**

    * Removes ALL booster messages from all channels
    * Resets the entire booster message system
    * Cannot be undone

    <Warning>
      This action is permanent and removes all booster message configurations. Use with caution!
    </Warning>

    **Aliases:** `boost reset`\
    **Permissions:** Manage Server
  </Accordion>

  <Accordion title="booster test" icon="flask">
    Test the booster message in a specific channel.

    <CodeGroup>
      ```bash Syntax theme={null}
      ~booster test <#channel>
      ```

      ```bash Examples theme={null}
      ~booster test #boosters
      ~boost test #general
      ```
    </CodeGroup>

    **What It Does:**

    * Sends a test booster message using your profile
    * Applies all variables as if you just boosted
    * Shows exactly how boosters will see the message
    * Pings you if ping is enabled

    **Aliases:** `boost test`\
    **Permissions:** Manage Server

    <Note>
      Only tests messages configured for the specified channel. Make sure you've added a booster message there first.
    </Note>
  </Accordion>
</AccordionGroup>

***

## Variable Reference

Use these variables in your booster messages for dynamic content:

| Variable              | Output                      | Example            |
| --------------------- | --------------------------- | ------------------ |
| `{user.mention}`      | Mentions the booster        | @Username          |
| `{user.tag}`          | User's full tag             | JohnDoe#1234       |
| `{user.id}`           | User's unique ID            | 123456789012345678 |
| `{guild.name}`        | Your server's name          | My Awesome Server  |
| `{guild.count}`       | Current member count        | 1,234              |
| `{guild.boost_count}` | Current number of boosts    | 14                 |
| `{guild.boost_tier}`  | Server boost tier           | 2                  |
| `{boost.goal}`        | Boosts needed for next tier | 7 or Max Level     |

***

## How It Works

<Steps>
  <Step title="Configure Booster Messages">
    Set up one or more booster messages using `booster add`:

    ```bash theme={null}
    ~booster add #boosters Thanks for boosting, {user.mention}! We now have {guild.boost_count} boosts!
    ~booster add #general {user.mention} just helped us reach boost tier {guild.boost_tier}! ping
    ```
  </Step>

  <Step title="Test Your Setup">
    Verify messages work correctly:

    ```bash theme={null}
    ~booster test #boosters
    ```
  </Step>

  <Step title="Automatic Thank You Messages">
    When members boost:

    * All configured booster messages are sent
    * Variables are replaced with actual values
    * Pings happen if enabled
    * Messages sent to their respective channels
  </Step>
</Steps>

***

## Permission Requirements

<CardGroup cols={2}>
  <Card title="Bot Permissions" icon="robot">
    The bot needs these permissions in booster channels:

    * View Channel
    * Send Messages
    * Embed Links (for embed messages)
    * Mention @everyone (for pings)
  </Card>

  <Card title="User Permissions" icon="user">
    Command Requirements:

    * **Manage Server** — Required for all booster commands
  </Card>
</CardGroup>

***

## Aliases

All booster commands support the `boost` alias:

<CardGroup cols={2}>
  <Card title="boost" icon="rocket">
    Short alias for all commands
  </Card>

  <Card title="booster" icon="sparkles">
    Full command name
  </Card>
</CardGroup>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Permission denied" icon="ban">
    **Problem:** "You need the Manage Server permission to use this command"

    **Solution:**

    * Verify you have the Manage Server permission
    * Check your role has sufficient permissions
    * Ask a server administrator for access
  </Accordion>

  <Accordion title="Booster message not sending" icon="message-slash">
    **Problem:** Booster messages don't send when members boost

    **Solutions:**

    * Verify bot has Send Messages permission in booster channel
    * Check bot has Embed Links permission (for embed messages)
    * Ensure channel hasn't been deleted
    * Run `~booster list` to verify configuration
    * Test with `~booster test #channel`
  </Accordion>

  <Accordion title="Embed not found" icon="file-circle-question">
    **Problem:** "Embed Not Found" error when using embed messages

    **Solutions:**

    * Verify the embed exists with the embed command
    * Ensure embed name is spelled correctly (case-sensitive)
    * Confirm embed is saved under your user account
    * Re-add the booster message with correct embed name
  </Accordion>

  <Accordion title="Variables not working" icon="code">
    **Problem:** Variables show as `{user.mention}` instead of actual values

    **Solutions:**

    * Check variable spelling exactly matches reference
    * Ensure you're using curly braces `{}`
    * Variables only work in text messages, not embed names
    * For embeds, variables must be in the embed content itself
  </Accordion>

  <Accordion title="Ping not working" icon="at">
    **Problem:** Boosters aren't getting pinged

    **Solutions:**

    * Ensure you added `ping` flag when setting up booster message
    * Check bot has Mention @everyone permission
    * Verify with `~booster list` to see if (ping) appears
    * Re-add the booster message with the ping flag
  </Accordion>
</AccordionGroup>

***

## Usage Examples

<Tabs>
  <Tab title="Basic Thanks">
    ```bash theme={null}
    # Simple text message
    ~booster add #boosters Thanks for boosting, {user.mention}!

    # With boost count
    ~booster add #general {user.mention} just boosted! We now have {guild.boost_count} boosts!

    # Multiple messages
    ~booster add #boosters Thank you {user.mention} for boosting!
    ~booster add #announcements {user.mention} helped us reach tier {guild.boost_tier}!
    ```
  </Tab>

  <Tab title="With Ping">
    ```bash theme={null}
    # Message with ping
    ~booster add #boosters Thanks {user.mention} for boosting {guild.name}! ping

    # Embed with ping
    ~booster add #general booster_thanks ping

    # Show boost progress
    ~booster add #boosters {user.mention} boosted! {boost.goal} boosts until next tier! ping
    ```
  </Tab>

  <Tab title="Using Embeds">
    ```bash theme={null}
    # First create an embed with the embed builder
    ~embed create booster_thanks

    # Then use it in booster messages
    ~booster add #boosters booster_thanks

    # With ping
    ~booster add #general fancy_boost_thanks ping
    ```
  </Tab>

  <Tab title="Multiple Channels">
    ```bash theme={null}
    # Different messages in different channels
    ~booster add #boosters Thank you {user.mention} for boosting!
    ~booster add #general {user.mention} just became a server booster! 🚀
    ~booster add #announcements We reached {guild.boost_count} boosts thanks to {user.mention}!
    ```
  </Tab>

  <Tab title="Management">
    ```bash theme={null}
    # View all booster messages
    ~booster list

    # Test a message
    ~booster test #boosters

    # Remove from specific channel
    ~booster remove #old-channel

    # Reset everything
    ~booster reset
    ```
  </Tab>
</Tabs>

***

## Boost Tier Information

Understanding boost tiers helps you create better messages:

<CardGroup cols={4}>
  <Card title="Level 0" icon="0">
    **0-1 Boosts**

    No perks unlocked
  </Card>

  <Card title="Level 1" icon="1">
    **2+ Boosts**

    * 50 extra emoji slots
    * 128 Kbps audio
    * Custom server invite background
    * Animated server icon
  </Card>

  <Card title="Level 2" icon="2">
    **7+ Boosts**

    Level 1 perks, plus:

    * 50 more emoji slots (150 total)
    * 256 Kbps audio
    * Server banner
    * 1080p 60fps screen share
  </Card>

  <Card title="Level 3" icon="3">
    **14+ Boosts**

    Level 2 perks, plus:

    * 100 more emoji slots (250 total)
    * 384 Kbps audio
    * Custom server invite URL
    * Animated server banner
  </Card>
</CardGroup>

***

## Example Messages

<Tabs>
  <Tab title="Simple">
    ```
    Thanks for boosting, {user.mention}! 🚀
    ```
  </Tab>

  <Tab title="With Progress">
    ```
    {user.mention} just boosted! We now have {guild.boost_count} boosts!
    Only {boost.goal} more until Level {guild.boost_tier + 1}!
    ```
  </Tab>

  <Tab title="Celebratory">
    ```
    🎉 {user.mention} just became a server booster!
    We're now at Tier {guild.boost_tier} with {guild.boost_count} boosts!
    Thanks for your support! 💜
    ```
  </Tab>

  <Tab title="Detailed">
    ```
    Thank you so much {user.mention} for boosting {guild.name}!

    Current Stats:
    🚀 Boost Tier: {guild.boost_tier}
    📊 Total Boosts: {guild.boost_count}
    🎯 Next Goal: {boost.goal}

    Your support helps us grow! 💜
    ```
  </Tab>
</Tabs>

***

## Related Features

<CardGroup cols={2}>
  <Card title="Embed Builder" icon="code" href="/embed-builder">
    Create custom embeds to use as booster messages
  </Card>

  <Card title="Booster Role" icon="star" href="/booster-role">
    Give boosters custom roles with personalized colors
  </Card>

  <Card title="Welcome Messages" icon="hand-wave" href="/welcome">
    Set up welcome messages for new members
  </Card>

  <Card title="Autorole" icon="user-tag" href="/autorole">
    Automatically assign roles to boosters
  </Card>
</CardGroup>