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

# Bump Reminder

> Automatically remind members to bump your server with Disboard integration

The Bump Reminder feature helps you maintain your server's visibility on Disboard by automatically reminding members when it's time to bump your server again.

## Requirements

* Server must be listed on Disboard
* Bot must have permissions to:
  * Send messages
  * Embed links
  * View channels

## Setup

### Enable Bump Reminder

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder enable
  ```

  ```bash Example theme={null}
  ,bumpreminder enable
  ```
</CodeGroup>

### Disable Bump Reminder

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder disable
  ```

  ```bash Example theme={null}
  ,bumpreminder disable
  ```
</CodeGroup>

## Customize Messages

### Set Thank You Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder thankyou <message>
  ```

  ```bash Example theme={null}
  ,bumpreminder thankyou {embed}{color: #24B8B8}$v{description: :thumbsup: Thank you for bumping the server! I will remind you **in 2 hours** to do it again}$v{content: {user.mention}}
  ```
</CodeGroup>

### Set Reminder Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder reminder <message>
  ```

  ```bash Example theme={null}
  ,bumpreminder reminder {embed}{color: #FF6465}$v{description: ⏰ Bump the server using `/bump`}$v{content: {user.mention}}
  ```
</CodeGroup>

## Testing Messages

### Test Thank You Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder test thankyou
  ```

  ```bash Example theme={null}
  ,bumpreminder test thankyou
  ```
</CodeGroup>

### Test Reminder Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder test reminder
  ```

  ```bash Example theme={null}
  ,bumpreminder test reminder
  ```
</CodeGroup>

## View Messages

### View Thank You Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder view thankyou
  ```

  ```bash Example theme={null}
  ,bumpreminder view thankyou
  ```
</CodeGroup>

### View Reminder Message

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder view reminder
  ```

  ```bash Example theme={null}
  ,bumpreminder view reminder
  ```
</CodeGroup>

## Leaderboard

### View Bump Leaderboard

<CodeGroup>
  ```bash Syntax theme={null}
  ,bumpreminder leaderboard
  ```

  ```bash Example theme={null}
  ,bumpreminder leaderboard
  ```
</CodeGroup>

## Variables

### Message Variables

* `{user}` - User object
* `{user.mention}` - User mention
* `{user.name}` - Username
* `{guild}` - Server object
* `{channel}` - Channel object

<Note>
  - Reminders are sent 2 hours after each bump
  - The leaderboard tracks the number of times each member has bumped the server
  - Messages support both regular text and embeds
</Note>

<Warning>
  Make sure the bot has proper permissions in the channel where bump reminders will be sent.
</Warning>