2024-12-15 23:43:33 +02:00
|
|
|
<h1 align="center">HoloBot Discord</h1>
|
2023-05-01 15:59:20 +03:00
|
|
|
|
2024-12-15 23:43:33 +02:00
|
|
|
<p align="center">Small Discord bot made on Py-Cord</p>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
<a href="https://git.end-play.xyz/HoloUA/Discord/src/branch/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
|
|
|
|
|
<a href="https://git.end-play.xyz/HoloUA/Discord"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
|
|
|
|
</p>
|
|
|
|
|
|
2024-12-17 23:29:03 +02:00
|
|
|
## Installation from release
|
2024-12-15 23:43:33 +02:00
|
|
|
|
2024-12-17 23:29:03 +02:00
|
|
|
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)
|
2024-12-15 23:43:33 +02:00
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
2024-12-15 23:45:57 +02:00
|
|
|
There's a file `config_example.json` which contains default configuration
|
2024-12-17 23:29:03 +02:00
|
|
|
and should be used as a base config.
|
2024-12-15 23:45:57 +02:00
|
|
|
|
2024-12-17 23:29:03 +02:00
|
|
|
Copy this file to `config.json` and open it with any text editor of your liking.
|
2024-12-15 23:45:57 +02:00
|
|
|
|
2024-12-17 23:29:03 +02:00
|
|
|
Modify the newly created configuration file to fit your needs.
|
2024-12-15 23:43:33 +02:00
|
|
|
|
|
|
|
|
Mandatory keys to modify:
|
|
|
|
|
|
|
|
|
|
- guild
|
|
|
|
|
- bot.owner
|
|
|
|
|
- bot.bot_token
|
|
|
|
|
- database.*
|
|
|
|
|
- categories.*
|
|
|
|
|
- channels.*
|
|
|
|
|
- roles.*
|
|
|
|
|
|
2024-12-17 23:29:03 +02:00
|
|
|
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`
|
