HoloBot Discord

Small Discord bot made on Py-Cord

License: GPL Code style: black

## Installation from release 1. Install MongoDB using the [official installation manual](https://www.mongodb.com/docs/manual/installation) 2. Install Python 3.9+ (3.11+ is recommended) 3. Download the [latest release](https://git.end-play.xyz/HoloUA/Discord/releases/latest)'s archive 4. Extract the archive 5. Navigate to the extracted folder and subfolder `Discord` in it 6. Create a virtual environment: `python -m venv .venv` or `virtualenv .venv` 7. Activate the virtual environment: Windows: `.venv\Scripts\activate.bat` Linux/macOS: `.venv/bin/activate` 8. Install dependencies: `python -m pip install -r requirements.txt` 9. Run the bot with `python main.py` after completing the [configuration](#Configuration) ## Installation with Git 1. Install MongoDB using the [official installation manual](https://www.mongodb.com/docs/manual/installation) 2. Install Python 3.9+ (3.11+ is recommended) 3. Clone the repository: `git clone https://git.end-play.xyz/HoloUA/Discord.git` 4. `cd Discord` 5. Install dependencies: `python -m pip install -r requirements.txt` 6. Run the bot with `python main.py` after completing the [configuration](#Configuration) ## Configuration There's a file `config_example.json` which contains default configuration and should be used as a base config. Copy this file to `config.json` and open it with any text editor of your liking. Modify the newly created configuration file to fit your needs. Mandatory keys to modify: - guild - bot.owner - bot.bot_token - database.* - categories.* - channels.* - roles.* After all of that you're good to go! Happy using :) ## Docker [Experimental] As an experiment, Docker deployment option has been added. ### Building the image 1. `git clone https://git.end-play.xyz/HoloUA/Discord.git` 2. `cd Discord` 3. `docker build -t holoua-discord .` ### Starting the bot 1. Install MongoDB using the [official installation manual](https://www.mongodb.com/docs/manual/installation) 2. Download the [configuration example file](https://git.end-play.xyz/HoloUA/Discord/src/branch/main/config_example.json) and store it somewhere you would like your bot to access it 3. Complete the [configuration](#Configuration) step for this file 4. `docker run -d -v /path/to/config.json:/app/config.json holoua-discord`