shi.gg
The weeb for the next gen discord boat - Wamellow
wamellow.com
bot
discord
fix ordering, add extra information & image
public/docs-assets/starboard-message-reference.webp
public/docs-assets/starboard-message-reference.webp
This is a binary file and will not be displayed.
+30
-37
public/docs/starboard.md
+30
-37
public/docs/starboard.md
···
1
-
# Starboard
2
1
Starboard provides a unique way to highlight noteworthy messages by allowing users to react with a designated emoji, ultimately showcasing them in a specific channel.
3
2
4
3
## Setup
5
4
1. Install Wamellow on your server by going to [wamellow.com/add](https://wamellow.com/add).
6
-
2. Head to the dashboard by going to [wamellow.com/dashboard](https://wamellow.com/dashboard)
5
+
2. Head to the dashboard by going to [wamellow.com/dashboard](https://wamellow.com/dashboard).
7
6
3. Select your server from the dashboard.
8
7
4. Navigate to the **Starboard** menu.
9
-
5. 🎉 Done! _Try it out by reacting to any message with X emote._
10
-
6. Enable the Starboard module by clicking the enabling button.
11
-
12
-
### 🗨️ Edit Channel
13
-
14
-
Modify the destination channel for starred messages.
15
-
16
-
### ⭐ Change Emoji
17
-
18
-
Select a new emote required for reacting. This can be any default Discord emote or a custom emote **from the same server**.
19
-
20
-
### 🔢 Change Count
21
-
22
-
Adjust the number of reactions needed with the chosen emote to showcase a message on the starboard channel.
8
+
5. Enable the Starboard module by clicking the enable button.
9
+
6. Select a channel for messages to be posted into.
10
+
7. **🎉 Done!** Try it out by reacting to any message with the selected emote.
23
11
24
-
### 🧑🦰 Disable/Enable Self Reaction
12
+
### 🤖 Allow bots & webhooks
13
+
Choose whether messages from bots or webhooks can be displayed on the starboard.
25
14
26
-
Determine whether message authors can star their own messages. When disallowed, the author's reaction will be removed.
27
-
28
-
### 🔞 Disable/Enable NSFW
29
-
15
+
### 🔞 Allow NSFW
30
16
Specify whether wamellow should include messages from NSFW-marked channels in the starboard.
31
17
32
-
### 🤖 Enable/Disable Bots & Webhooks
18
+
### 🖊️ Allow message edits
19
+
If allowed, messages that are edited will also be updated in the starboard.
33
20
34
-
Determine whether messages from bots or webhooks can be displayed on the starboard.
21
+
**Note:** To prevent abusing the starboard, it's recommended to leave this option disabled.
35
22
36
-
### 📝 Show/Hide replied to
23
+
### 🧑🦰 Allow author reaction
24
+
Whether the message author can star their own messages. When disallowed, the author's reaction will automatically be removed.
37
25
26
+
### 📝 Display message reference
38
27
Choose whether the replied message should be visible within the starboard or not.
39
28
40
-
### 🖊️ Allow/Disallow Edits
29
+
41
30
42
-
If allowed, messages that are edited will also be updated in the starboard.
31
+
### 🗑️ Delete message from starboard upon losing reactions
32
+
If a message in the starboard looses the required reactions, it gets deleted from the starboard. Messages will reappear once they gain enough reactions again.
43
33
44
-
### ❌ Edit Blacklisted Roles
34
+
### 🔢 Number of reactions required
35
+
Adjust the number of reactions needed with the chosen emote to send a message to the starboard channel.
45
36
46
-
Specify roles that are restricted from starring other people's messages and prevent their own messages from appearing on the starboard.
37
+
### ⭐ Custom emoji
38
+
Select a custom emote required for reacting. This can be any default Discord emote or a custom emote from your server.
47
39
48
-
### ⚙️ Edit Blacklisted Channels
49
-
50
-
Designate specific channels where message starring is not permitted.
51
-
52
-
### 🗑️ Enable/Disable x Reactions
53
-
54
-
If enabled, Wamellow will remove messages from the starboard channel that no longer meet the required star count.
40
+
### 😍 Profile display style
41
+
Chose what should be displayed of the message author.
42
+
- Username (`@mwlica`)
43
+
- Global Nickname (`yll`)
44
+
- Guild Nickname (`Luna`)
45
+
- Guild Nickname & Per-Guild Avatar
55
46
56
-
### 😍 Display Type
47
+
### ❌ Blacklisted roles
48
+
Specify roles that are restricted from starring other people's messages and prevent their own messages from appearing on the starboard.
57
49
58
-
Choose a style how the user should get displayed.
50
+
### ⚙️ Blacklisted channels
51
+
Designate specific channels where message starring will be ignored.
59
52