Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 7.36 KB

configuration.md

File metadata and controls

67 lines (54 loc) · 7.36 KB

Usage of the config command

The .config command allows you to modify how Suggester will work in your server, giving you the ability to customize notifications, permissions, reactions and much more! We'll dive into it later, for now let's talk about the command itself.

?> Looking to quickly setup the bot? Try the .setup command instead!

How can I use it?

To edit a configuration element, use .config [element] [value] in any channel the bot can read and send messages in. There are currently 30+ different settings you can customize, which you can find more information on the table below.so we heavily recommand against it.

Optional Arguments

.config list will show the server's current configuration
.config [element] will show the current value of a specific element
.config help with no other argument will show an interactive menu explaining what each element does
.config help [element] will show more information about a specific element

Aliases

serverconfig, cfg and configure

Permission

Any member with the Manage Server permission or a configured admin role can modify the server configuration.

!> Warning: Adding the @everyone role as an admin role will give everyone in your server elevated permissions, so we heavily recommend against it.

Configuration Elements

Element Default Value Quick Description¹
Admin Roles² Roles with all perms
Allowed Roles Roles allowed to send suggestions
Anonymous Suggestions Disabled Settings for anonymous feedback
Approve Role Roles given to the author of a suggestion when it gets approved
Autofollowing Enabled Settings for autofollowing
Blocked Roles Roles blocked from sending suggestions
Clean Commands Disabled Settings for commands deletion
Color Change 15 votes • #FFD700 Change the color of the suggestion embed when it reaches X net upvotes
Commands List of channels where commands can be used
Comment Timestamps Enabled Settings for comment timestamps
Cooldown None Suggestion cooldown
Denied Channel where denied suggestions are posted
Disabled Channels Channels where commands can't be used
Disabled Commands Disabled commands can't be used
Emojis 👍,🤷 and 👎 Reaction emojis to vote on approved suggestions
Feed Ping Role pinged when a suggestion is approved
Commandless Suggestions Disabled Settings for commandless suggestion submission
Implemented Channel where implemented suggestions are sent
Implemented Role Role given to the author of a suggestion when it gets marked as Implemented
Language English Server-wide setting for the language used by the bot
Live Vote Count Enabled Preferences for vote count
Logs Channel where all actions are logged
Mode² Suggestion handling mode
Notifications Enabled Settings for notifications
One Vote Enabled Settings to limit voting to only one reaction
Prefix² . Symbol to use before commands (eg. .help)
Review² Channel where pending suggestions are sent
Review Ping Role pinged when a new suggestion is submitted
Self Vote Enabled Settings to limit voting on your own suggestions
Staff Roles² Roles with suggestion managing perms
Suggestion Cap None Maximum of concurrent approved suggestions
Suggestions Feed² Channel where approved suggestions are sent
Voting Roles All roles List of roles allowed to vote

¹ Click on the option name for more information about it!
² These elements are required for the bot to function properly. If you haven't configured one of those, you'll get a lovely error!

?> Forum Channels are not currently supported and may not be set when configuring elements that accept a channel input.