38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
<h1 align="center">HoloBot Discord</h1>
|
|
|
|
<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>
|
|
|
|
## Installation
|
|
|
|
1. Install MongoDB using the [official installation manual](https://www.mongodb.com/docs/manual/installation/).
|
|
2. `git clone https://git.end-play.xyz/HoloUA/Discord.git`
|
|
3. `cd Discord`
|
|
4. Install Python 3.9+ (at least 3.11 is recommended) for your OS
|
|
5. `python3 -m pip install -r requirements.txt`
|
|
6. Run it with `python3 main.py` after configuring
|
|
|
|
## 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 :) |