Getting Started Guide

This guide is intended as a quick-start for getting the bot set up with customizable settings for your server.

All of the features listed here are off by default, so you don't have to worry about anything being out of order.

IMPORTANT NOTE: It is recommended to give the bot the ADMINISTRATOR permission so that it has the correct permissions required in order to perform its interactions with the server and the server members.

Terms of Service

- Feature that displays customizable terms of service (or rules list) in a channel, and gives new users a "default" role when they accept the terms.

syntax: !tos (channel|title|body|list|status) (#channelMention | message number) (text)

This feature has multiple steps to set up:

  1. Set up the title and body text for each block of text for your rules/tos list.
  2. Set up the channel to display the rules in. We recommend setting up a channel that you have as your main invite for new members, and making it so new members can only see the content in this channel and no others.
  3. Set that channel as the tos channel by running: !tos channel #channelMention
  4. Go into that channel, and run: !tos list to list out all the tos/rules blocks you set previously.
  5. Set up a default role that grants users access to all the other basic channels in your server. This way new users are behind a wall until they accept your rules/tos
  6. Then add this role as the default by running: !role default @roleMention
  7. Lastly, set the channel for accepting the tos/rules accept command by running: !accept #channelMention. This sets the channel (your rules/tos channel from the previous part), for new users to type !accept and then be granted access to your server.


Welcome Message

- Welcomes a new user to your server with a customizable message.

syntax: !welcome (text | #channelMention)

Enable this feature, then set the welcome message to your liking, and don't forget to set the channel for the messages to appear!


Goodbye Message

- Informs a channel of a user's departure from your server with a customizable message.

syntax: !goodbye (text | #channelMention)

Enable this feature, then set the goodbye message to your liking, and don't forget to set the channel for the messages to appear!


Delete Command Messages

- Automatically delete the calling message when a command is run. This helps keep chat free of junk messages.

syntax: !deletecommandmessages

Go ahead and simply enable or disable this feature.


Self-Assignable Roles

- Allow users to self assign roles from a list of approved ones.

syntax: !role (@roleMention)

Setup of this feature is pretty straightforward. After setting a few roles for your members to add for themselves, they can add/remove them by running: !iam/!iamnot @roleMention


Moderator Log

- Logs all moderation-related actions to a channel for recordkeeping.

syntax: !modlog

This is a great feature for keeping track of what's going on in your server, rather than sifting through the audit log. Easy to set up, too!


Bot Command Prefix

- Change the bot's command prefix.

syntax: !prefix (prefix|none|default)

This one is pretty straightforward. Some people prefer using a different prefix to use Spudnik.


Embed Color

- Customize the color of the response embed from the bot.

syntax: !embedcolor (hex color)

This one is pretty straightforward. Change the color, or don't.


Bot Nickname

- Change the bot's nickname on your server.

syntax: !nick (new nickname)

Another straightforward one. Spudnik is also known as Sir Taterpants in some circles.


Adblocker

- Automatically delete any message containing an invite to another Discord server, unless posted by an Administrator.

syntax: !adblock

Go ahead and simply enable or disable this feature.


Starboard

- Feature that saves messages to a specified channel for archiving when one is reacted to with a customizable emoji.

syntax: !starboard (new starboard emoji | #channelMention)

Keep in mind when setting the reaction trigger emoji, currently only official emojis are supported.


Enable/Disable Commands

- You can enable/disable individual commands or entire command groups!

syntax: !disable/!enable

Command groups can be seen by running: !groups