discord-bot

This project builds a simple Discord bot which was designed to make our Discord life easier and cooler.

Features

/echo <message>: Echo the same message content to the user
/ban <user> [reason]: Ban user
/kick <user> [reason]: Kick user
/brodcast <channel> <message> <minutes>: Send the scheduled message to a channel
/unbrodcast <channel>: Remove the scheduled message from a channel
/clear <channel>: Clear the chat history of a channel
/text_channel <channel>: Create a channel
/rm_text_channel <channel>: Delete a channel
/send_to <channel> <message>: Send the message to a specific channel

[arg]: optional argument; <arg>: required arugment

Setup

1. Installation

Python version
- python >= 3.10

Clone repository

git clone git@github.com:Retr0327/discord-bot.git

Install Requirement

cd discord-bot && pip install -r requirements.txt

2. Environment variables

Please create a .env file under the current folder /discord-bot:

TOKEN=[discord-bot-token]
GUILD=[discord-channel-id]

3. Start the bot

There are two main ways to run the bot:

in Python

First make sure you are in the discord-bot folder, and then simply run:
```
python ./bot/bot.py
```
or
```
python -u "./bot/bot.py"
```
run in Docker

Install Docker, and use the following command to run:
```
docker compose up
```

Commands Guide

This bot accepts only slash commands

1. User related

`/echo <message>`

Echo the exact same message content back to the user, providing a response to their original message.

`/ban <user> [reason]`

Impose a mute on a particular user, preventing he/she from sending messages in a specified channel. You can optionally supply a reason argument to specify the reason for the mute.

`/kick <user> [reason]`

Remove a specific user from a channel. You can optionally supply a reason argument to specify the reason for kicking he/she out.

2. Channel related

`/brodcast <channel> <message> <minutes>`

Regularly send messages to a specific channel. Here is the overview of the brodcasting architecture:

flowchart RL
    subgraph DB
      direction LR
      g[("<div style='padding: 0rem 0.5rem;'>SQLite</div>  ")]
    end

      B[Schedule request] --> C((Bot event loop))
      C -- Trigger callback --> B
      C -- Register callback --> DB
      DB -- Operation complete --> C

When a user broadcasts a message to a particular channel, the Discord bot logs the task in its event loop. Upon restart, the bot examines the database for any pending tasks and incorporates them into the loop if any are found.

`/unbrodcast <channel>`

Remove the scheduled message from a channel. In other words, the Discord bot will cancel the scheduled task from its event loop.

`/clear <channel>`

Clear the chat history of a specific channel.

`/text_channel <channel>`

Create a Discord text channel.

`/rm_text_channel <channel>`

Delete a Discord text channel.

`/send_to <channel> <message>`

Send the message to a specific channel.

Contact Me

If you have any suggestion or question, please do not hesitate to email me at lixingyang.dev@gmail.com

Retr0327 / discord-bot