Configuration

Server Role

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 archive and clean 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

Here's an example of the recommended permission set for AwesomeBot:

Admin Console

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.

Header

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.

Bot Admins

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.

Blocked Members

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).

Strikes

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 a strike in the main chat by using @user strike+ or @user strike-, or use the buttons in the web interface:

RSS Feeds

Here you can add custom RSS feeds that can be used in chat to fetch the latest posts without having to use the entire URL. This is a great place to find RSS feeds.

Command Settings

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

Management

This is where you can control AwesomeBot's moderation features on the server:

• Member joined/left messages are sent whenever a member is added, removed, banned, or unbanned.
• 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.
• 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.
• The new member greeting is sent to users via PM immediately after they join the server. By default, it includes information about AwesomeBot and his help section, but admins can add a server-specific message.
• Clean allows you to clear the last n messages from the bot in a channel.
• Archive provides a JSON file of all of the last n messages in a channel.

Trivia Sets

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"
    }
  ]
}

Extensions

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.

Footer

Here you can refresh the server settings, change the theme of the interface, or log out.

Maintainer Console

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.

Header

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

Servers

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.

Globally Blocked Users

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.

Footer