# Rocketbot

Discord bot for detecting and dealing with jerks. This bot is Rocketsoup's fault.

## Requirements

* Python 3.9

## Setup

See main document, [docs/setup.md](Setup).

In brief, the full setup process is:
- create a Discord application in their developer portal
- configure a `config.py`
- install Python dependencies
- run the `main.py` script
- invite the bot to your server
- do additional configuration for your guild using chat commands

## Usage

See main document, [docs/commands.md](Commands).

* To see the list of commands, type `$rb_help`.
* To get help on a specific command, type `$rb_help commandname` (don't prefix the command name you want help on). E.g. `$rb_help hello`.
* To get help on a command group, type `$rb_help groupname`. E.g. `$rb_help config`.
* To get help on a subcommand in a group, type `$rb_help groupname commandname`. E.g. `$rb_help config setwarningchannel`.
* To see if the bot is alive, type `$rb_hello`.