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

# Starboard

> Archive popular messages to a dedicated channel — and run as many boards as you like.

When a message gets enough of a particular reaction, it's reposted to a starboard channel. The classic use is a `⭐` hall of fame, but you can run any number of boards on different emojis at once — a `🤡` clownboard, a `💀` board, whatever your server does.

Requires **Manage Server**.

## Creating one

```javascript theme={null}
!starboard add #starboard ⭐
```

That's a working starboard with the default threshold of 3.

<CodeGroup>
  ```javascript With settings up front theme={null}
  !starboard add #starboard ⭐ --threshold 5 --self false --color member
  ```

  ```javascript A second board theme={null}
  !starboard add #clownboard 🤡 --threshold 4
  ```

  ```javascript Remove one theme={null}
  !starboard remove #starboard ⭐
  ```

  ```javascript See them all theme={null}
  !starboard list
  ```

  ```javascript Remove every board theme={null}
  !starboard clear
  ```
</CodeGroup>

### Creation flags

| Flag          | Aliases     | Default  | Values                                         |
| ------------- | ----------- | -------- | ---------------------------------------------- |
| `--threshold` | `limit`     | `3`      | 1–12                                           |
| `--self`      | `self_star` | `true`   | Allow authors to star their own                |
| `--color`     | `colour`    | `member` | Hex, colour name, `member`, `random` or `none` |
| `--timestamp` | `time`      | `true`   | Show the original timestamp                    |

`--color member` uses the author's role colour, which is the nicest-looking default.

## Adjusting a board

Every setting command takes the **emoji** to identify which board you mean:

<CodeGroup>
  ```javascript Reaction count theme={null}
  !starboard threshold ⭐ 5
  ```

  ```javascript Colour theme={null}
  !starboard color ⭐ #f4c430
  !starboard color ⭐ random
  ```

  ```javascript Self-starring theme={null}
  !starboard selfstar ⭐ off
  ```

  ```javascript Timestamp theme={null}
  !starboard timestamp ⭐ off
  ```

  ```javascript Jump link theme={null}
  !starboard jump ⭐ on
  ```

  ```javascript Button instead of a link theme={null}
  !starboard button ⭐ on
  ```

  ```javascript Pin entries theme={null}
  !starboard pin ⭐ on
  ```
</CodeGroup>

`jump` puts a "Jump to message" link in the embed; `button` replaces that link with an actual button, which looks cleaner. Turning `button` on makes `jump` redundant.

## Ignoring things

<CodeGroup>
  ```javascript A channel theme={null}
  !starboard ignore #nsfw
  ```

  ```javascript A member theme={null}
  !starboard ignore @someone
  ```

  ```javascript A role theme={null}
  !starboard ignore @Muted
  ```

  ```javascript View theme={null}
  !starboard ignore list
  ```

  ```javascript Un-ignore theme={null}
  !starboard ignore remove #nsfw
  ```

  ```javascript Clear theme={null}
  !starboard ignore clear
  ```
</CodeGroup>

The ignore list applies to **every** board, not per emoji. Aliases: `blacklist`, `ignored`, `bl`.

## How entries behave

* **Reaction count is live.** If reactions drop back below the threshold, the entry is removed.
* **Edits propagate.** Editing the original updates the starboard copy.
* **Deletions propagate.** Deleting the original removes the entry.
* **Attachments come along.** Images, videos and stickers are carried into the entry.
* **Replies show context.** If the starred message was a reply, that's reflected.

## Choosing a threshold

Roughly proportional to how many people are actually active, not how many members you have:

| Active chatters | Threshold |
| --------------- | --------- |
| Under 20        | `2`–`3`   |
| 20–100          | `3`–`5`   |
| 100–500         | `5`–`8`   |
| 500+            | `8`–`12`  |

Too low and the starboard becomes a second general chat. Too high and it never fires. Start lower than you think and raise it once you see the volume.

## Command reference

| Command                                   | Aliases                           | Description          |
| ----------------------------------------- | --------------------------------- | -------------------- |
| `starboard add <channel> <emoji> [flags]` | `create`, `new`                   | Create a board       |
| `starboard remove <channel> <emoji>`      | `delete`, `del`, `rm`             | Remove a board       |
| `starboard list`                          | `configuration`, `overview`, `ov` | View all boards      |
| `starboard clear`                         | `reset`, `purge`                  | Remove every board   |
| `starboard threshold <emoji> <count>`     | `reactions`, `limit`              | Reaction count       |
| `starboard color <emoji> <color>`         | `colour`                          | Embed colour         |
| `starboard selfstar <emoji> (on/off)`     | `self`                            | Allow self-starring  |
| `starboard timestamp <emoji> (on/off)`    | `time`                            | Show the timestamp   |
| `starboard jump <emoji> (on/off)`         | `jump_url`, `link`                | Include a jump link  |
| `starboard button <emoji> (on/off)`       | `buttons`                         | Use a button instead |
| `starboard pin <emoji> (on/off)`          | `pins`                            | Pin entries          |
| `starboard ignore <target>`               | `blacklist`, `bl`                 | Toggle an ignore     |
| `starboard ignore list`                   | `ls`, `view`                      | View ignores         |
| `starboard ignore remove <target>`        | `unignore`                        | Un-ignore            |
| `starboard ignore clear`                  | `reset`, `purge`                  | Clear ignores        |

Every command requires **Manage Server**. Group aliases: `star`, `board`, `sb`.
