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

# Starboard

> Highlight your server's best messages with jar's starboard system.

## Introduction

jar's starboard system allows you to highlight your server's best messages by sending them to a
dedicated channel when they receive a certain number of reactions.
This is useful for showcasing high-quality content and engaging your community.

<Tip>
  You can set up an **additional starboard** by using `clownboard` instead of `starboard`.
</Tip>

## Setting up a starboard

Follow these steps to set up a starboard in your server.

<Steps>
  <Step title="Create a new channel">
    Create a new **text channel** where the starboard messages will be sent.
    You need to ensure jar has the **following permissions** in this channel:

    * `Send Messages`
    * `Embed Links`
    * `Attach Files`

    <Warning>
      If you don't give **all 3 permissions**, jar will not be able
      to send starboard messages to the channel.
    </Warning>
  </Step>

  <Step title="Tell jar to set up the starboard">
    Use the following command to tell jar to set up the starboard:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard setup <channel>
      ```

      ```ruby Example theme={null}
      ,,starboard setup #hall-of-fame
      ```
    </CodeGroup>

    jar will then set up the starboard in the specified channel.
  </Step>

  <Step title="React to messages">
    To send a message to the starboard, users need to react to the message with the specified emoji.

    By default, jar looks for the ⭐ emoji, but you can change this in the settings.
    Once a message receives enough reactions, it will be sent to the starboard channel.
  </Step>
</Steps>

## Configuring the starboard

You can configure the starboard by using the following commands.
To view the current settings, use the following command:

<CodeGroup>
  ```ruby Syntax theme={null}
  starboard settings
  ```

  ```ruby Example theme={null}
  ,,starboard settings
  ```
</CodeGroup>

<AccordionGroup>
  <Accordion title="Enable/disable the starboard">
    Use the following commands to enable or disable the starboard:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard enable
      starboard disable
      ```

      ```ruby Example theme={null}
      ,,starboard enable
      ,,starboard disable
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Set the number of reactions required">
    Use the following command to set the number of reactions required for a message to be sent to the starboard:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard threshold <number>
      ```

      ```ruby Example theme={null}
      ,,starboard threshold 5
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Set the reaction emoji">
    Use the following command to set the reaction emoji jar should look for:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard emoji <emoji>
      ```

      ```ruby Example theme={null}
      ,,starboard emoji ⭐
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Set the starboard channel">
    Use the following command to set the starboard channel:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard channel <channel>
      ```

      ```ruby Example theme={null}
      ,,starboard channel #hall-of-fame
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Set the starboard colour">
    Use the following command to set the starboard colour:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard colour <hex colour>
      ```

      ```ruby Example theme={null}
      ,,starboard colour #FFD700
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Disallow users to self star">
    Use the following command to allow/deny users from starring their own messages:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard selfstar <true/false>
      ```

      ```ruby Example theme={null}
      ,,starboard selfstar false
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Show/hide attachments on the starboard">
    Use the following command to show/hide attachments on the starboard:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard attachments <true/false>
      ```

      ```ruby Example theme={null}
      ,,starboard attachments true
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Show/hide jump URLs on the starboard">
    Use the following command to show/hide jump URLs on the starboard:
    The jump URL is a link that allows users to
    jump to the original message in the starboard channel.

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard jumpurls <true/false>
      ```

      ```ruby Example theme={null}
      ,,starboard jumpurls true
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Show/hide the timestamp on the starboard">
    Use the following command to show/hide the timestamp on the starboard:

    <CodeGroup>
      ```ruby Syntax theme={null}
      starboard timestamp <true/false>
      ```

      ```ruby Example theme={null}
      ,,starboard timestamp true
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>

## Ignoring an entity from the starboard

You can ignore specific users, channels and roles from being sent to the starboard.
To ignore a user, channel or role use the following command:

<CodeGroup>
  ```ruby Syntax theme={null}
  starboard ignore <user or channel or role>
  ```

  ```ruby Example theme={null}
  ,,starboard ignore @jaradc
  ,,starboard ignore #general
  ,,starboard ignore @Moderator
  ```
</CodeGroup>

jar will then confirm the ignore by showing you the ignored entity.

<Tip>
  To **stop ignoring** a user, channel or role you use the same command again.
</Tip>

## Resetting the starboard

If you want to reset the starboard, you can use the following command:

<CodeGroup>
  ```ruby Syntax theme={null}
  starboard reset
  ```

  ```ruby Example theme={null}
  ,,starboard reset
  ```
</CodeGroup>

jar will then confirm the reset by showing you a message indicating that the starboard has been reset.
Your settings, ignored entities & previously starred messages will be cleared.