trueold89/HellMBot
trueold89
/
HellMBot
1
0
Fork 0
Code Packages Releases 2 Activity

Update README.md 

- Update style
- Fix docker-compose example
- Add GitLab & Discord link
- Add emoji to headers
This commit is contained in:
trueold89 2024-06-04 18:39:53 +03:00
parent 34088a2107
commit 60f8b2357a
Signed by: trueold89
GPG Key ID: C122E85DD49E6B30
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,23 +1,20 @@
# HellMBot # HellMBot
### Discord bot that will wake your friends up from full mute by putting them through 9 circles of hell ### Discord bot that will wake your friends up from full mute by putting them through 9 circles of hell 🔥
![](https://cdn.orudo.ru/.work/trueold89/git/hellm/Header.png) ![](https://cdn.orudo.ru/.work/trueold89/git/hellm/Header.svg)
## Source code: ## 🔗 Links:
[<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/orudo.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://git.orudo.ru/trueold89/HellMBot) [<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/ORUDO.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://git.orudo.ru/trueold89/HellMBot)
[<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/github.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://github.com/Trueold89/HellMBot) [<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/GitHub.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://github.com/Trueold89/HellMBot)
[<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/GitLab.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://gitlab.com/Trueold89/hellmbot)
[<img src="https://cdn.orudo.ru/.work/trueold89/git/hellm/Discord.svg" alt="SVG Image" width="300" height="102" style="padding-right: 10px">](https://discord.com/oauth2/authorize?client_id=1247176574969577514)
*** ***
![](https://cdn.orudo.ru/.work/trueold89/git/hellm/example.gif) ## ⁉️ Usage:
*** ![](https://cdn.orudo.ru/.work/trueold89/git/hellm/faq.svg)
## Usage:
![](https://cdn.orudo.ru/.work/trueold89/git/hellm/faq.png)
--- ---
@ -28,14 +25,14 @@
- **Move any user (or yourself, if you're a masochist) to any of the channels in the group created by bot** - **Move any user (or yourself, if you're a masochist) to any of the channels in the group created by bot**
- **Have fun!** - **Have fun!**
## Deploy: ## 📦 Deploy:
*** ***
### Python venv: ### Python venv:
![](https://cdn.orudo.ru/.work/trueold89/git/hellm/python.png) ![](https://cdn.orudo.ru/.work/trueold89/git/hellm/python.svg)
- **Install python package from [git.orudo.ru](https://git.orudo.ru/trueold89/HellMBot/packages)**: - **Install python package from [git.orudo.ru](https://git.orudo.ru/trueold89/HellMBot/packages)**:
```shell ```shell
@ -83,7 +80,7 @@ heelm
### Docker: ### Docker:
![](https://cdn.orudo.ru/.work/trueold89/git/hellm/docker.png) ![](https://cdn.orudo.ru/.work/trueold89/git/hellm/docker.svg)
- **Pull image from [git.orudo.ru](https://git.orudo.ru/trueold89/HellMBot/packages)**: - **Pull image from [git.orudo.ru](https://git.orudo.ru/trueold89/HellMBot/packages)**:
```shell ```shell
@ -128,7 +125,7 @@ docker run \
```yml ```yml
services: services:
qbitdl_bot: hellm_bot:
image: git.orudo.ru/trueold89/hellmbot:latest image: git.orudo.ru/trueold89/hellmbot:latest
container_name: HellMBot container_name: HellMBot
volumes: volumes:
@ -137,6 +134,8 @@ services:
environment: environment:
BOT_TOKEN: "insertyourbottokenhere" BOT_TOKEN: "insertyourbottokenhere"
CLIENT_ID: "insertyourclientidhere" CLIENT_ID: "insertyourclientidhere"
volumes:
hellm_db:
``` ```
```shell ```shell
@ -145,11 +144,11 @@ docker compose up -d
*** ***
## Available system environment variables ## 📋 Available system environment variables
*** ***
- `BOT_TOKEN` - **Discord Bot TOKEN** *[(How to get)](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)* - `BOT_TOKEN` - **Discord Bot TOKEN** *[(How to get)](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)*
- `CLIENT_ID` - **Discord Application ID** *[(How to get)](https://docs.discordadvertising.com/getting-your-application-id)* - `CLIENT_ID` - **Discord Application ID** *[(How to get)](https://docs.discordadvertising.com/getting-your-application-id)*
- `DB_PATH` - **Path to SQLite DataBase file** *(Optional | Highly recommended to change when running bot on Windows systems) (Default Value: "/etc/hellmbot/database.sqlite")* - `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)* - `CIRCLES_COUNT` - **Number of channels the bot creates when the "/create" command is activated.** *(Optional)* *(Default value: 9)*