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

# Boost Greet

> Send a custom thank-you message whenever someone boosts your server.

Boost Greet sends a customized message to a channel of your choice whenever a member boosts your server. It detects boosts through both the member update event and the system boost message, with built-in duplicate prevention so you never get spammed with double messages.

<Note>
  **Required Permission:** [Admin Access](/permissions/admin-access) or higher — Server Owner, Extra Owner, Trusted User, or Administrator with a role above the bot can use these commands.
</Note>

<Warning>
  **Premium Feature:** This module requires an active Premium subscription. If the server's premium expires, the boost greet system will be automatically disabled.
</Warning>

## Setting Up

Follow these steps to configure the boost greeting for your server.

<Steps>
  <Step title="Run the Set Command">
    Provide the channel and your boost message.

    ```bash theme={null}
    .boostgreet set #boost-log We just got boosted by {user}! We now have {boostcount} boosts!
    ```

    A preview of the message will be shown before saving.
  </Step>

  <Step title="Test It">
    Send a test message to verify the output.

    ```bash theme={null}
    .boostgreet test
    ```
  </Step>
</Steps>

<Warning>
  You must set up the boost message **before** someone boosts. If no configuration exists when a boost happens, nothing will be sent.
</Warning>

***

## Commands

| Command                            | Description                                          |
| :--------------------------------- | :--------------------------------------------------- |
| `.boostgreet set <channel> <text>` | Sets the boost message and channel                   |
| `.boostgreet show`                 | Shows the current boost message with a live preview  |
| `.boostgreet test`                 | Sends a test boost message to the configured channel |
| `.boostgreet reset`                | Deletes the boost message configuration              |
| `.boostgreet enable`               | Enables the boost message                            |
| `.boostgreet disable`              | Disables the boost message                           |

***

## Customizing Messages

The boost message is fully customizable and supports both **dynamic variables** and **custom embeds**.

### Using Variables

You can dynamically insert information like the booster's name, boost count, or server tier. Refer to the [Variables](/resources/variables) reference for the full list.

**Available contexts:** Server, Channel, User, Author, Target

<CodeGroup>
  ```bash Input theme={null}
  .boostgreet set #boosts Thank you {user} for boosting {servername}! We are at {boostcount} boosts and tier {boostlevel}!
  ```

  ```text Output theme={null}
  Thank you @jane_doe for boosting ZEON Official! We are at 15 boosts and tier 3!
  ```
</CodeGroup>

### Using Custom Embeds

Design a rich embed using the interactive embed builder, then attach it to your message with the `{embed:name}` syntax.

<Steps>
  <Step title="Create the Embed">
    ```bash theme={null}
    .embed create boost_thanks
    ```

    Use the dropdown menu to customize title, description, color, images, and variables.
  </Step>

  <Step title="Attach to Message">
    ```bash theme={null}
    .boostgreet set #boosts {user} just boosted! {embed:boost_thanks}
    ```
  </Step>
</Steps>

<Note>
  The `{embed:name}` placeholder is invisible in the final output. The bot strips it from the text and attaches the rich embed below the message. Variables placed inside the embed builder will also parse correctly.
</Note>

### Limitations

<Warning>
  * A boost message configuration **must be reset** before setting a new one. Use `.boostgreet reset` first.
  * If the configured channel is deleted, boost messages will silently fail until a new channel is set.
  * Duplicate boosts within a **5 second window** are automatically suppressed to prevent spam.
</Warning>