> ## 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.

# Starboard

> Create a collection of highly-reacted messages in a dedicated channel with Greed's Starboard feature

The Starboard feature allows you to create a collection of highly-reacted messages in a dedicated channel. When messages receive enough reactions (meeting the threshold), they are automatically posted to the starboard channel. This is perfect for highlighting community favorites, important announcements, or memorable moments.

## Requirements

* Server must have at least one text channel for the starboard
* Bot must have permissions to:
  * Read messages
  * Send messages
  * Add reactions
  * Manage messages (for editing/updating starboard entries)
  * View channels
  * Read message history

## Add a Starboard

To create a new starboard channel:

<CodeGroup>
  ```bash Syntax theme={null}
  ,starboard add (channel) (emoji) (threshold)
  ```

  ```bash Example theme={null}
  ,starboard add #starboard ⭐ 5
  ,starboard add #memes 🤡 3
  ```
</CodeGroup>

* `channel`: The channel where starboard messages will be posted
* `emoji`: The reaction emoji to track (can be any valid emoji)
* `threshold`: Minimum number of reactions required to appear in starboard

## List Starboards

View all starboards currently set up in your server:

<CodeGroup>
  ```bash Syntax theme={null}
  ,starboard list
  ```

  ```bash Example theme={null}
  ,starboard list
  ```
</CodeGroup>

This will show all starboard channels, their associated emojis, and reaction thresholds.

## Remove a Starboard

To remove a starboard:

<CodeGroup>
  ```bash Syntax theme={null}
  ,starboard remove (channel) (emoji)
  ```

  ```bash Example theme={null}
  ,starboard remove #starboard ⭐
  ```
</CodeGroup>

## Ignore Channels

You can prevent certain channels from being added to the starboard:

<CodeGroup>
  ```bash Syntax theme={null}
  ,starboard ignore (channel)
  ,starboard unignore (channel)
  ```

  ```bash Example theme={null}
  ,starboard ignore #announcements
  ,starboard unignore #announcements
  ```
</CodeGroup>

## Move Starboard

To move a starboard to a different channel:

<CodeGroup>
  ```bash Syntax theme={null}
  ,starboard move (emoji) (channel)
  ```

  ```bash Example theme={null}
  ,starboard move ⭐ #new-starboard
  ```
</CodeGroup>

<Info>
  On the patch released on 15th of June you can now add these settings:
</Info>

<CodeGroup>
  ## Setting Starboard Color

  ```bash Syntax theme={null}
  ,starboard color (emoji) (color)
  ```

  ```bash Example theme={null}
  ,starboard color 💀 #ffffff
  ```
</CodeGroup>

<CodeGroup>
  ## Changing Timestamp Settings

  ```bash Syntax theme={null}
  ,starboard timestamp (emoji) (state)
  ```

  ```bash Example theme={null}
  ,starboard timestamp 💀 off
  ```
</CodeGroup>

<CodeGroup>
  ## Jumpurl Enable

  ```bash Syntax theme={null}
  ,starboard jumpurl (emoji) (state)
  ```

  ```bash Example theme={null}
  ,starboard jumpurl 💀 on
  ```
</CodeGroup>

<CodeGroup>
  ## Enabling & Disabling Attachments

  ```bash Syntax theme={null}
  ,starboard attachments (emoji) (state)
  ```

  ```bash Example theme={null}
  ,starboard attachments 💀 on
  ```
</CodeGroup>

<Info>
  Additionally, you can now ignore `members`, `channels`, or `roles`.
</Info>

## Special Features

### Star Emoji Progression

When using the ⭐ emoji, the starboard will automatically upgrade the emoji based on reaction count:

* 0-4 reactions: ⭐
* 5-9 reactions: 🌟
* 10-24 reactions: 💫
* 25+ reactions: ✨

### Message Format

Starboard entries include:

* Original message content
* Author information
* Channel source
* Jump link to original message
* Reaction count
* Attached images/videos
* Reply context (if the message was a reply)

### Batch Processing

The starboard uses a batch processing system to handle reactions efficiently:

* Reactions are queued and processed every 5 seconds
* Messages are processed in chunks of 5 to prevent rate limiting
* Updates are batched to minimize API calls

<Note>
  Starboard messages are automatically updated when reaction counts change, and they're removed if the reaction count falls below the threshold.
</Note>

<Warning>
  Deleting a starboard channel will automatically remove its configuration. Make sure to properly remove starboards using the remove command before deleting channels.
</Warning>
