Brother Chris

Description

My personal Discord bot Made for educational purposes: to learn Discord bots and Python.

Commands

Commands can only be executed by the users specified in the configuration.
Commands can be executed with prefixes specified in the configuration.
An optional argument cannot be passed without also passing all preceding arguments regardless of if they are optional.

[] denotes mandatory arguments. <> denotes optional arguments.

created <channel> - Retrieves date and time at which channel was created. If channel is not specified, the current channel is used.
emojiurl [emoji] - Retrieves a url to the custom emoji.
icon <user> - If user is specified, retrieves user's avatar. Otherwise, retrieves the current server's icon.
id <user> - Retrieves IDs for user, current channel, and current server.
- user defaults to the caller of the command.
perms <user> <channel> - Retrieves a list of permissions for user in channel.
react [emoji] [limit] - Reacts with emoji to a quantity (limit) of previous messages in the current channel.
wc <user> <channel> <limit> <colour> - Generates a word cloud with colour as the background based on a quantity (limit) of user's messages from channel.
- user defaults to the caller of the commands.
- channel defaults to the channel in which the command was called.
- limit defaults to 1000.
- colour defaults to transparent. Format is a CSS3-style colour specifier; read the ImageColor documentation for more information.

Configuration

A file named Configuration.json and in the same directory as bot.py is used for configuration of the bot. Below is the base configuration for the bot; it is the bare-minimum required for the bot to run properly.

{
    "Bot": {
        "token": "",
        "user_ids": [
            123456789012345678
        ],
        "extensions": [
            "brotherchris.cogs.Commands"
        ],
        "prefixes": [
            "!",
            "?"
        ],
        "name": "Brother Chris"
    }
}

token - The bot's token.
user_ids - A list of user IDs which identify who can use the bot. Any other user's messages with commands are completely ignored.
extensions - A list of extensions for the bot to load.
prefixes - A list of prefixes to use for commands.
name - The bot's name. Only used for logging right now.

Some additional extensions require more configuration. Their configurations go after the Bot object.

Permissions

"Permissions": {
    "justify": true,
    "padding": 4
},

justify - If true, the permission name column of the output is left-justified and padded with the with a width of padding.
padding - One less than the width of space between the name and and value columns.

Welcome

"Welcome": {
    "dyno_id": 155149108183695360,
    "channels": [
        123456789012345678
    ],
    "dyno_msg": "joined the server! Give them a welcome!"
}

dyno_id - The ID of the bot that sends the messages to listen for.
channels - A list of channel IDs in which to listen for the bot's messages.
dyno_msg - The search string used to determine if the bot's message is a welcome.

Word Police

"WordPolice": {
    "server_ids": [
        123456789012345678
    ],
    "thumbnail": "",
    "words": {
        "book": [
            "cook",
            "look"
        ],
        "books": [
            "cooks",
            "looks"
        ]
    }
}

server_ids - A list of server IDs in which to listen for messages.
thumbnail - A URL to the thumbnail to use in the embed.
words -

Requirements

Binaries

Python 3.8

Packages

Note pipenv can install these automatically (apart from pipenv itself) from the provided Pipfiles.

Installation

pipenv can be used to simply the installation process. Once it is installed, cd into the root directory and install the dependencies from the pipfile with

pipenv install

An error may occur while installing wordcloud on Windows. More specifically

Failed building wheel for wordcloud

The error can be circumvented by downloading a pre-built wheel of wordcloud from here. Download the version of the wheel appropriate for your Python version and OS. To finish the install, run

pipenv install /path/to/wordcloud-wheel-file.whl

Running

Run bot.py to run the bot. If using pipenv:

pipenv run start

otherwise

python -m brotherchris

MarkKoz/brother-chris