HellMBot/README.md

4.3 KiB

HellMBot

Discord bot that will wake your friends up from full mute by putting them through 9 circles of hell 🔥

SVG Image SVG Image SVG Image SVG Image


⁉️ Usage:


  • Add bot to your server
  • Update the bot's permissions to prevent unnecessary people from using its commands (optional)
  • Type /create in any text chat you want
  • Write /create in whatever text chat you want
  • Move any user (or yourself, if you're a masochist) to any of the channels in the group created by bot
  • Have fun!

📦 Deploy:


Python venv:

pip install pip install --extra-index-url https://git.orudo.ru/api/packages/trueold89/pypi/simple/ HellMBot 
  • Or build your own package from sources:

Clone source code repo:

git clone https://git.orudo.ru/trueold89/HellMBot.git && cd HellMBot

Install build deps:

pip install setuptools

Build package:

python3 setup.py sdist

Install built package:

pip install dist/*

export BOT_TOKEN=insertyourbottokenhere
export CLIENT_ID=insertyourclientidhere

  • Start bot:
heelm

Docker:

docker pull git.orudo.ru/trueold89/hellmbot:latest
  • Or build your own image:

Clone source code repo:

git clone https://git.orudo.ru/trueold89/HellMBot.git && cd HellMBot/docker

Edit the Dockerfile with your changes (Optional)

Build image:

docker build -t hellmbot .

  • Create docker volume that will use to store DataBase:
docker volume create hellm_db

  • Deploy using docker-cli:
docker run \
 --name HellMBot\
 --restart=unless-stopped \
 -v hellm_db:/etc/hellmbot/
 -e BOT_TOKEN="insertyourbottokenhere" \
 -e CLIENT_ID="insertyourclientidhere" \
 -d git.orudo.ru/trueold89/hellmbot:latest
  • Or using docker-compose:
services:
  hellm_bot:
    image: git.orudo.ru/trueold89/hellmbot:latest
    container_name: HellMBot 
    volumes:
      - hellm_db:/etc/hellmbot
    restart: 'unless-stopped'
    environment:
      BOT_TOKEN: "insertyourbottokenhere"
      CLIENT_ID: "insertyourclientidhere"
volumes:
    hellm_db:
docker compose up -d

📋 Available system environment variables


  • BOT_TOKEN - Discord Bot TOKEN (How to get)
  • CLIENT_ID - Discord Application ID (How to get)
  • DB_PATH - Path to SQLite DataBase file (Optional | Highly recommended to change when running bot on Windows systems) (Default Value: "/etc/hellmbot/database.sqlite")
  • CIRCLES_COUNT - Number of channels the bot creates when the "/create" command is activated. (Optional) (Default value: 9)

Other:

Design file (Figma Community)