diff --git a/README.md b/README.md index e65e019..a81b9a1 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,20 @@ # 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: -[SVG Image](https://git.orudo.ru/trueold89/HellMBot) -[SVG Image](https://github.com/Trueold89/HellMBot) +## 🔗 Links: +[SVG Image](https://git.orudo.ru/trueold89/HellMBot) +[SVG Image](https://github.com/Trueold89/HellMBot) +[SVG Image](https://gitlab.com/Trueold89/hellmbot) +[SVG Image](https://discord.com/oauth2/authorize?client_id=1247176574969577514) *** -![](https://cdn.orudo.ru/.work/trueold89/git/hellm/example.gif) +## ⁉️ Usage: -*** - -## Usage: - - -![](https://cdn.orudo.ru/.work/trueold89/git/hellm/faq.png) +![](https://cdn.orudo.ru/.work/trueold89/git/hellm/faq.svg) --- @@ -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** - **Have fun!** -## Deploy: +## 📦 Deploy: *** ### 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)**: ```shell @@ -83,7 +80,7 @@ heelm ### 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)**: ```shell @@ -128,7 +125,7 @@ docker run \ ```yml services: - qbitdl_bot: + hellm_bot: image: git.orudo.ru/trueold89/hellmbot:latest container_name: HellMBot volumes: @@ -137,6 +134,8 @@ services: environment: BOT_TOKEN: "insertyourbottokenhere" CLIENT_ID: "insertyourclientidhere" +volumes: + hellm_db: ``` ```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)* - `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")* -- `CIRCLES_COUNT` - **Number of channels the bot creates when the "/create" command is activated.** *(Optional)* *(Default value: 9)* \ No newline at end of file +- `CIRCLES_COUNT` - **Number of channels the bot creates when the "/create" command is activated.** *(Optional)* *(Default value: 9)* diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 56d4afd..240cbdc 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -8,5 +8,5 @@ services: environment: BOT_TOKEN: "insertyourbottokenhere" CLIENT_ID: "insertyourclientidhere" - volumes: - hellm_db: +volumes: + hellm_db: diff --git a/setup.py b/setup.py index e58436e..69018af 100644 --- a/setup.py +++ b/setup.py @@ -9,7 +9,6 @@ setup( author_email="trueold89@orudo.ru", description="Discord bot that will wake your friends up from full mute by putting them through 9 circles of hell", packages=["hellmbot"], - long_description=open("README.md").read(), install_requires=["discord.py"], entry_points={ "console_scripts": ["hellm = hellmbot.bot:start"]