Updated README

This commit is contained in:
Profitroll 2023-01-17 15:10:04 +01:00
parent 0f7a860dad
commit 9b8d389031

View File

@ -15,18 +15,19 @@ Installation instructions are listed below. Please, make sure you have installed
5. `python yusarin.py` 5. `python yusarin.py`
## Installation (Detailed) ## Installation (Detailed)
1. Download and install Python 3 (3.6+ should be fine) 1. Download and install Python3.8+
2. Download bot's release: https://git.end-play.xyz/profitroll/YusarinBot/releases/latest 2. Download bot's release: https://git.end-play.xyz/profitroll/YusarinBot/releases/latest
3. Unpack your archive to folder. Name it YusarinBot for example 3. Unpack your archive to folder. Name it YusarinBot for example
4. Change working directory using `cd YusarinBot` or `cd FolderYouHaveCreated` 4. Change working directory using `cd YusarinBot` or `cd FolderYouHaveCreated`
5. Run `pip install -r requirements.txt` to install dependencies 5. Run `pip install -r requirements.txt` to install dependencies
6. Create new Discord application at https://discord.com/developers/applications 6. [Optionally] run `pip install -r requirements-optional.txt` to install optional dependencies
7. You can rename it however you want, set needed descriptions etc 7. Create new Discord application at https://discord.com/developers/applications
8. Go to "Bot" tab and enable application as bot 8. You can rename it however you want, set needed descriptions etc
9. Copy token of your bot 9. Go to "Bot" tab and enable application as bot
10. Open file `config.json` with your favorite text editor and paste your token as value of "bot_token" key 10. Copy token of your bot
11. Copy your own Discord ID and paste it as value of "owner" key (How to get ID: https://support.playhive.com/discord-user-id/) 11. Open file `config.json` with your favorite text editor and paste your token as value of "bot_token" key
12. Bot is ready! Run it using `python yusarin.py` 12. Copy your own Discord ID and paste it as value of "owner" key (How to get ID: https://support.playhive.com/discord-user-id/)
13. Bot is ready! Run it using `python yusarin.py`
## Config explanation ## Config explanation
Default configuration file is [available here](https://git.end-play.xyz/profitroll/YusarinBot/blob/main/config.json) Default configuration file is [available here](https://git.end-play.xyz/profitroll/YusarinBot/blob/main/config.json)