52 lines
2.6 KiB
Markdown
52 lines
2.6 KiB
Markdown
<h1 align="center">GloryBot</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://git.end-play.xyz/VA-11_Hall-A/GloryBot/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/VA-11_Hall-A/GloryBot"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
|
</p>
|
|
|
|
Discord bot based on [Pycord](https://github.com/Pycord-Development/pycord) and [LibBotUniversal](https://git.end-play.xyz/profitroll/LibBotUniversal) that provides interesting captcha for your server.
|
|
|
|
## Requirements
|
|
|
|
* MongoDB
|
|
* Python 3.8+ (3.11 is recommended)
|
|
* Git (when installing from source)
|
|
|
|
## Installation
|
|
|
|
There are two kinds of installation supported. Stable one is basically a stable release that you can download and use. Upgrades will need some more complicated actions on your side. The source one provides you with easier code management, yet is meant to be used by more advanced users.
|
|
|
|
### Stable
|
|
|
|
1. Install all [requirements](#requirements) except for Git
|
|
2. Go to [Releases](/releases) and download the stable release of your choice
|
|
3. Unpack the archive somewhere you like (`/opt/GloryBot` on Linux or `C:\Program Files\GloryBot` on Windows will do)
|
|
4. Open the terminal in project's folder and create a virtual environment: `python -m venv .venv`
|
|
5. Activate the virtual environment: `.venv/bin/activate` on Linux and `.venv\Scripts\activate.bat` on Windows
|
|
6. Install all requirements: `pip install requirements.txt`
|
|
7. Create a config file by copying the `config_example.json` to `config.json`: `cp config_example.json config.json`
|
|
8. Configure the bot's `config.json` using your favorite text editor
|
|
9. Run the bot: `python main.py`
|
|
|
|
### From source
|
|
|
|
1. Install all [requirements](#requirements)
|
|
2. Go to the directory of your liking and open a terminal there: For example, `/opt` on Linux or `C:\Program Files` on Windows
|
|
3. Clone the repository: `git clone https://git.end-play.xyz/VA-11_Hall-A/GloryBot.git`
|
|
4. Change directory to the cloned project: `cd GloryBot`
|
|
5. Open the terminal in project's folder and create a virtual environment: `python -m venv .venv`
|
|
6. Activate the virtual environment: `.venv/bin/activate` on Linux and `.venv\Scripts\activate.bat` on Windows
|
|
7. Install all requirements: `pip install requirements.txt`
|
|
8. Create a config file by copying the `config_example.json` to `config.json`: `cp config_example.json config.json`
|
|
9. Configure the bot's `config.json` using your favorite text editor
|
|
10. Run the bot: `python main.py`
|
|
|
|
## Upgrading
|
|
|
|
To-Do
|
|
|
|
## Creating a service
|
|
|
|
To-Do
|