Skip to main content

​
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.
You can set up an additional starboard by using clownboard instead of starboard.

​
Setting up a starboard

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

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
If you don’t give all 3 permissions, jar will not be able to send starboard messages to the channel.
2

Tell jar to set up the starboard

Use the following command to tell jar to set up the starboard:
starboard setup <channel>
jar will then set up the starboard in the specified channel.
3

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.

​
Configuring the starboard

You can configure the starboard by using the following commands. To view the current settings, use the following command: 
starboard settings
Use the following commands to enable or disable the starboard:
starboard enable
starboard disable
Use the following command to set the number of reactions required for a message to be sent to the starboard:
starboard threshold <number>
Use the following command to set the reaction emoji jar should look for:
starboard emoji <emoji>
Use the following command to set the starboard channel:
starboard channel <channel>
Use the following command to set the starboard colour:
starboard colour <hex colour>
Use the following command to allow/deny users from starring their own messages:
starboard selfstar <true/false>
Use the following command to show/hide attachments on the starboard:
starboard attachments <true/false>
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.
starboard jumpurls <true/false>
Use the following command to show/hide the timestamp on the starboard:
starboard timestamp <true/false>

​
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: 
starboard ignore <user or channel or role>
jar will then confirm the ignore by showing you the ignored entity.
To stop ignoring a user, channel or role you use the same command again.

​
Resetting the starboard

If you want to reset the starboard, you can use the following command: 
starboard reset
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.