Suggestions
Advanced module to manage suggestions on your guild.
Suggestions
Advanced module to manage suggestions on your guild
This module is open-source.
This module is storing data in your bot's database.
This module creates 2 top-level Slash-Commands on your server.
This module has one configuration file.
This module is being actively used on over 2.9K other servers on SCNX.
This module is included for free in every plan. Learn more about prices.
Features
- Let your users submit suggestions on Discord using
- commands
- messages in a designated channel (optional)
- Approve / Deny suggestions from users
- Let users vote for suggestions using reactions
- Automatically open threads below new suggestions (optional)
Setup
- Create (or designate) a channel for suggestions. The bot needs the following permissions on this channel: "View channel", "Send messages" and "View message history"
- Make sure that the permissions
/manage-suggestions
are configured correctly to avoid users managing suggestions as admins. - Open the Module configuration.
- Configure the module.
- Reload the configuration to apply changes.
Usage
- Users can submit a new suggestion with
/suggestion
. New suggestions get sent in the configured Suggestion-Channel. - If enabled, messages sent in the Suggestion-Channel will be converted into suggestions automatically.
- Other users can vote with configured reactions and can comment on suggestion using threads.
- Admins can deny or approve suggestions with
/manage-suggestions
and optionally add a reason for their decision. This will notify the suggestion creator via DMs, if configured.
Commands
Understand the documentation
In these docs,
name:<Type>
is an option of a slash-command with name name
and the type Type
. Options that not required, are described as [name:<Type>]
. If the action of a command is vastly different between required and not-required options, we might list them separately.Examples
/moderate ban user:<Member>
: This command (/moderate ban) has an required option with the name "user" that only accepts one member as a value./moderate ban victim:<Member> reason:<Text>
: This command (/moderate ban) has an required option with the name "victim" that only accepts one member as a value and another required option with the name "reason" that accepts any text as an value./moderate ban victim:<Member> reason:<Text> [proof:<Attachment>]
: This command (/moderate ban) has an required option with the name "victim" that only accepts one member as a value, another required option with the name "reason" that accepts any text as an value and a not-required option with the name "proof" which allows one attachment as its value.
Command | Description |
---|---|
/suggestion suggestion:<Text> | Allows users to submit a new suggestion into the suggestion-channel. |
/manage-suggestion accept id:<SuggestionID> comment:<Text> | Allows admins to accept a suggestion submitted by a user. The comment will be displayed in the updated suggestion message. |
/manage-suggestion deny id:<SuggestionID> comment:<Text> | Allows admins to deny a suggestion submitted by a user. The comment will be displayed in the updated suggestion message. |
Configuration
This configuration file allows you to configure features of the module and to change the appearance of messages. Open it in your dashboard.
Field | Description |
---|---|
Suggestion-Channel | Channel in which new suggestions get posted and (if "Create suggestions from messages in channel" is enabled) suggestions will be created from. |
Create suggestions from messages in channel | If enabled, messages sent by users in the Suggestion-Channel will be converted to a suggestion automatically. |
Reactions | The bot will add these reactions below suggestions. You could these reactions as voting (e.g. with 👍 and 👎 ). Please enter either the Unicode-Version (for built-in-emojis) or the Emoji-ID (for custom emojis). |
User-Comments in threads | If enabled, the bot will create a new thread under each suggestion to allow users to comment. Commenting via commands has been removed. |
Thread-Name | Only visible if "User-Comments in threads" is enabled This will be the name of the thread created below suggestions. |
"Successfully submitted"-Message | This is the message shown to users after they have submitted their suggestion using the /suggestion command. |
Notification-Role | This role will be pinged every time a new suggestion is created. |
Send DM-Notifications | If enabled, the creator of the thread will be sent a DM when their suggestion was answered by an administrator. |
DM-Status-Notification | Only visible if "Send DM-Notifications" is enabled This is the message that will get sent to the creator of the thread when their suggestion was answered by an administrator. |
Unanswered Suggestion-Message | This is how a suggestion without an admin-answer will look in the suggestion-channel. This will be edited when an admin responds. |
Denied Suggestion-Message | This is how a suggestion that has been denied by an admin will look like. The original message ("unanswered suggestion-message") will be edited to this value when an admin denies the suggestion. |
Approved Suggestion-Message | This is how a suggestion that has been accepted by an admin will look like. The original message ("unanswered suggestion-message") will be edited to this value when an admin approves the suggestion. |
Troubleshooting
A suggestion is not being created
Please check the following:
- Make sure the "Unanswered Suggestion-Message", "Denied Suggestion-Message" and "Approved Suggestion-Message" fields are correctly configured.
- Make sure the bot has the required permissions on the suggestion channel: "View channel", "Send messages" and "View message history".
- Make sure the configured Ping-Roles are correct (or the field is empty).
- Make sure the Thread-Name is shorter than 100 characters.
- Make sure that reactions are in the proper Unicode-Format (if you are using a built-in-emoji) or the Discord-Emoji-Format (for custom emojis).
- If you are using the "Create suggestions from messages in channel" feature, please make sure the bot has permissions to "Manage messages".
I can't respond to a suggestion as an admin
Please check the following:
- Make sure the "Denied Suggestion-Message" and "Approved Suggestion-Message" fields are correctly configured.
- Make sure the bot has the required permissions on the suggestion channel: "View channel", "Send messages" and "View message history".
- Make sure that the suggestion hasn't been answered by an admin yet. If you didn't set up the permissions for
/manage-suggestion
, a user might have been able to respond to the suggestion as an admin.
Stored data
The following data is being stored about every suggestion created via commands or by sending a message in the configured channel (if enabled):
- An unique integer identifying the database entry
- The content of the suggestion (
suggestion
parameter of the/suggestion
command or the content of the message sent) - The ID of the message sent by the bot in the configured channel
- ID of the user who submitted the suggestion
- The answer of the admin, consisting of the following:
- Type of answer (
deny
orapprove
) - Reason for this answer (
comment
parameter of the/manage-suggestion
command) - ID of the admin
- Type of answer (
- For suggestions created in a version below v3.4.6: All comments submitted via commands, consisting of the following:
- Content of the comment
- ID of the user who added the comment
- Metadata about the entry (date when created and last updated)
There is no way to remove a suggestion from the database (you can always delete the suggestion-message regardless). To remove all suggestions, purge the module database.