Configuration
When you add AwesomeBot to a server, we recommend that you give it a role with the following basic permissions:
- Read Messages so he can recognize commands
- Send Messages for responses to commands
- Embed Links to fetch info from around the web
There are also a few extra permissions for additional functionality:
- Read Message History to use the clean, purge, and archive options in the admin console
- Kick Members for automatic spam and NSFW regulation (if enabled)
- Manage Roles to assign custom roles and colors to users
- Manage Messages to use the purge option in the admin console
- Change Nickname to set a custom name for the server
Here's an example of the recommended permission set for AwesomeBot:
The AwesomeBot admin console allows you to configure the bot's settings for usage on any server where you are one of his admins. By default, anyone with permission to ban users is added as an admin. To access the configuration page, use the command config <server name>.
In this section, we'll examine each section of the admin console and explain how to use it.
The header is pretty simple; it shows how long ago the bot was added to the server and gives you an option to remove the bot from the server. You can also click on the bot's name to change its nickname on the server, if it has permission to do so.
The upper-right buttons allow you to change the page theme, get help with the admin console (this page), or logout.
Here you can add/remove bot admins (you can't remove yourself or the server owner). Admins can configure the bot on the server, clear stats, close polls/trivia games, and use the strikes system.
Users who are on the blocked list cannot interact with AwesomeBot at all on the server. This is a great way to prevent bot spam from abusive people. Members are automatically blocked for a second-time spam/NSFW violation (if enabled), and those identified with (global) have been blocked throughout AwesomeBot by the maintainer (you can't unblock them, and they're usually bots).
You can also mute blocked members in certain channels. Click the blue mute button and select the channels in which you want to prevent the user from sending messages. Note that for this to work, AwesomeBot must have role management permissions on the server.
Want to stop users talking temporarily? Users on the mute list cannot talk on the channels you have selected. You can select individual channels or all of them. It simple to use, simply select the user to block and what channels to block on or all channels.
In the past, server mods have had to either remember which members have violated the rules or keep track with a spreadsheet - but those solutions are cumbersome and often ineffective. AwesomeBot provides a strikes system for admins to easily keep track of who's breaking the rules in a semi-private way. Strikes are automatically added for spam/NSFW violations (if enabled) and are shown in each member's profile. You can add, remove, and view strikes in the admin console web interface:
The add button allows you create a new strike for a user, and the view button lists strikes, as seen below:
A timestamp is automatically added!
Enable these commands to collect stats about members, games and messages. You can also enable text commands to view stats in discord too! You can also block these commands from being used in certain channels too, reducing spam in certain channels.
You can now assign special ranks to members based on their messages account. Either use the default rank list or use your own! Roles will show up using the profile command and you can auto-add people to ranks based on their messages role.
Here you can enable and disable AwesomePoints, a powerful karma system for Discord which allows users to reward each other Learn more here
This section gives you precise control over every AwesomeBot command. You can enable/disable any commands that you don't want to be used server-wide. You can also choose custom presets, which keep AwesomeBot's core commands but removes bulk:
- Full enables everything
- Lite is the slimmest preset, enabling only media commands, reddit, the trivia game, and NSFW filter
- Sense keeps the useful commands and disables the bloat
- Default resets all configs for the server, so be careful when using it
You'll also notice a "command modifier" dropdown, which allows you to change how AwesomeBot detects commands. You can choose from @AwesomeBot ping, !ping, +ping, and more.
Finally, there's the API keys section. Look, we know, rate limits suck - but they're a thing we have to deal with. Of course, AwesomeBot has global API keys for image search, YouTube, and others, but if we exceed the limit, all servers can't use the command anymore. This section allows you to use a custom API key for your server and your server only. This way, you can pay for API access without affecting other servers.
Here you can add custom RSS feeds, allowing you to fetch the latest posts without leaving Discord. You can also set the bot to auto post any new posts in your chosen feed. You can also add GitHub, Reddit or Twitter feeds and allow them to auto post as well.
This is a great place to find RSS feeds: https://www.repeatserver.com/RSSFeedList.aspx
With the introduction of the translate command in v3.3.18, you can now automagically translate messages from certain users who may have trouble with English. Select a member username and the source language code.
You can now view and join other servers by looking at http://bot.awesomebot.xyz/ You can opt out from your bot logs and server data being public.
This is where you can control AwesomeBot's moderation features on the server. The first checkbox is a global toggle for many of the options listed below. The second controls the auto-prune option, which will kick members who have not sent a message for an amount of time you select.
AwesomeBot can display customized messages when a user has joined, left, been banned, unbanned, changed their username, started a Twitch stream, edited/deleted a message, and even if they have gone offline/come online. You can add and remove greetings as you wish; ++ will be replaced with the username. The dropdown selects the channel that the message will be shown in.
You can also set a role automatically given to new members, or a custom greeting that will be shown to new members via PM by filling in the large text box.
Similar options are available for messages when members leave.
The spam filter checks for similar messages sent by the same user within 45 seconds. If 5 spam messages are sent, the user receives a warning and the admins are notified. If it happens again, the user is kicked or blocked (depending on whether the bot has the kick permission) and admins are notified again. You can change the sensitivity, too!
The NSFW filter works similarly to the spam filter, but checks for attempts to fetch inappropriate content through the bot. The full list of filtered words is available here.
You can control both of these per-channel, which is great if you have a channel dedicated for spam or NSFW content.
Right below the NSFW filter options you'll see a giant textbox. The words in entered here (separated by commas) are filtered in the server, meaning that users that use them in a message will be warned first and then blocked/kicked.
Archive provides a JSON file of all of the last n messages in a channel. Clean allows you to clear the last n messages from the bot in a channel. Purge clears the last n messages from all users in a channel. This functionality is also available in-chat with the nuke and archive commands.
If you've given AwesomeBot role management permissions on your server, you can allow users to set a custom color or role for themselves. You can select which roles members can join and whether custom roles can be created.
This section allows you to add custom question sets to AwesomeBot's excellent live group trivia game. Upload a JSON file with the following format:
{
"name": "Example",
"stream": [
{
"category": "You Should Know This",
"question": "What is the meaning of life, the universe, and everything?",
"answer": "42"
},
{
"category": "You Should Know This",
"question": "Who is the creator of AwesomeBot?",
"answer": "BitQuote"
}
]
}
You can add custom functionality to the bot without having to host your own bot or modifying the core code. Upload a JSON file to the admin console, following the instructions here.
The bot maintainer is the only user with access to the maintainer console (access it by PMing the bot config). It allows you to view overall command usage, add/remove servers, block users globally, and more.
The header for the maintainer console contains perhaps the most useful options:
- Click on the bot's username to change it
- Click on the bot game to change it
- Change the bot status with the dropdown
- Click on the bot's avatar to change it
You can also use the top-right buttons to change the page theme, get help (this wiki page), or logout.
This section shows a list of every server the bot has joined, including the icon, owner, and ID. You also have the option to remove the bot from each server or clear the stats there for the week.
Users who are blocked globally cannot use the bot anywhere. That means all servers and PM. Bots are automatically added to the global blocklist and you can manually add extremely abusive users.
This section gives you links to download all the files in the data folder, in case you need it. There's also an option to clear the logfile because sometimes it can get annoyingly large.
With BigMessage™, you can easily send a message to all servers. This is great for announcements or status updates!
This section also includes an option to have all PMs sent to the bot forwarded to you. Use it only for debugging - it gets really spammy.