Skip to content
Starboard

Customising The Starboard Message

Starboard offers many ways to customise the starboard message.

You can view all the basic appearance settings Starboard has to offer with the following command:

/settings view

The command to change a setting will be found in the corresponding category the setting is listed in. For example, the command to change Reupload Attachments (found in the Appearance category), is /settings edit appearance.

Display Tiers

The main way you can customise messages is by changing the cosmetic star displayed beside the star count, and the colour of the starboard message’s embeds. You can do this via Display Tiers.

/displaytiers create threshold 10 star ✨ colour #ecd558 / rgb(236, 213, 88)

Your server already has 4 display tiers created for you by default:

  1. ⭐ #eee2a0 from 0 stars
  2. 🌟 #f0dd76 from 10 stars
  3. 💫 #ecd558 from 20 stars
  4. ✨ #ecc014 from 30 stars

Of course, you can edit the default display tiers:

/displaytiers edit tier 1 star 🍣

Display tiers are applied one after the other, and allow you to set the star/colour depending on how many stars the message has. For example, let’s say you have display tiers set up as follows:

  1. ⭐ #eee2a0 from 0 stars
  2. 💫 #ecd558 from 2 stars
  3. #ecc014 from 3 stars
  4. ✨ from 5 stars

In this scenario, the starboard message will change based on how many stars the starred message has:

  1. ⭐ #eee2a0
  2. 💫 #ecd558
  3. 💫 #ecc014
  4. 💫 #ecc014
  5. ✨ #ecc014

Basic Settings

There are also a wide range of settings for customisation of the starboard message, found in the Appearance category.

Name Display

The Name Display setting controls how the starred message author’s name should be displayed on starboard messages. It also has an effect on which avatar is used.

There are 3 options:

  • Server Nickname (also uses server avatar, if any)
  • Display Name (also uses server avatar, if any)
  • Username (uses global avatar)
/settings edit appearance name-display Server Nickname

Mention Author

If you want users to be mentioned on their starboard messages, enable the Mention Author setting.

/settings edit appearance mention-author True
Image showing what enabling the Mention Author setting looks like.

This is disabled by default.

Display Avatar

The Display Avatar setting determines whether or not user avatars are displayed on starboard messages.

/settings edit appearance display-avatar False

This is enabled by default.

Display Replied Message

If a message that’s a reply to another message gets starred, a snippet of the message that was replied to is shown on the starboard message, for context. This behaviour is controlled by the Display Replied Message setting.

/settings edit appearance display-replied-message True
Image showing how the snippet of the message that was replied to looks like.

This is enabled by default.

Reupload Attachments

Bots cannot display videos in embeds, so they are displayed as links instead. However, you’re given the option to have the bot download videos, files, and extra attachments, and reupload them on the starboard message so users can easily view them there.

/settings edit appearance reupload-attachments True
Image showing what enabling the Reupload Attachments setting looks like.

The Message Jump Link setting determines how the original message is linked on the starboard messages so people can find it.

/settings edit appearance message-jump-link Mention Link
Image showing what the different options for Message Jump Link look like.

For files and links, the bot will list them either as text links or as button links, depending on the value of the Use Links Over Buttons setting.

/settings edit appearance use-links-over-buttons False
Image showing what enabling the Use Links Over Buttons setting looks like.

The bot uses buttons for links by default.

Size Limits

There are 4 simple appearance settings that limit the size of starboard messages. Here’s an example of a long message:

A screenshot of a super long message with several attachments.A screenshot of a super long starboard message with several attachments.

Max Content Displayed

This is the maximum number of characters of the original message’s content to display on starboard messages. Any extra characters will be truncated.

/settings edit appearance max-content-displayed 200
Image showing the long starboard message with Max Content Displayed set to 200.

Max Embeds Displayed

This is the maximum number of embeds the bot is allowed to use to display a single starboard message.

/settings edit appearance max-embeds-displayed 2
Image showing the long starboard message with Max Embeds Displayed set to 2.

In the above image, only 2 embeds are used and the remaining content is linked.

Max Media Displayed

This is the maximum number of images/videos/files the bot is allowed to display, the rest being linked.

/settings edit appearance max-media-displayed 1
Image showing the long starboard message with Max Media Displayed set to 3.

In the above image, only 1 image was embedded, the remaining were linked instead.

Max Overall Message Length

This is the maximum number of characters that are allowed to be displayed on the starboard message in total. This truncates all of the message’s content, including replied message content and text embed content. This setting is very similar to Max Content Displayed.

/settings edit appearance max-overall-message-length 1000

Custom Bot

Have a special community bot or a server theme to follow? You can configure a custom bot to use to post starboard messages, while the magic of Starboard works in the background.

The custom bot will only be used for posting and editing starboard messages, everything else (commands, auto-star, reward roles, etc.) will be handled by me as normal.

All you have to do is provide the token of your custom bot:

/custom-bot set token NjU1Mzkw...

And that’s it! Starboard messages will now be posted using your custom bot’s profile.