diff --git a/README.md b/README.md index 7cab0f4..47c6f4c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ -# YusarinBot -[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) [![Crowdin](https://badges.crowdin.net/yusarinbot/localized.svg)](https://crowdin.com/project/yusarinbot) ![Discord](https://img.shields.io/discord/940760922346123284) +

YusarinBot

+ +

+ + License: GPL v2 + + + Crowdin + + + Code style: black + + + Discord + +

Simple, easy to set up, yet reliable. A specially designed bot for creating private voice channels on your Discord servers. @@ -8,6 +22,7 @@ Installation instructions are listed below. Please, make sure you have installed > Since version 1.5 only slash commands are supported. If you'd like to use old-fashioned commands and commands prefix feature – consider installing [1.4 version](https://git.end-play.xyz/profitroll/YusarinBot/releases/tag/v1.4) which is the last one compatible with those. ## Installation (Short) + 1. `git clone https://git.end-play.xyz/profitroll/YusarinBot` 2. `cd YusarinBot` 3. `pip install -r requirements.txt` @@ -15,23 +30,26 @@ Installation instructions are listed below. Please, make sure you have installed 5. `python yusarin.py` ## Installation (Detailed) + 1. Download and install Python 3.8+ -2. Download bot's release: https://git.end-play.xyz/profitroll/YusarinBot/releases/latest +2. Download bot's release: 3. Unpack your archive to folder. Name it YusarinBot for example 4. Change working directory using `cd YusarinBot` or `cd FolderYouHaveCreated` 5. If you're using Linux system - install [dependencies for Pycord](https://docs.pycord.dev/en/stable/installing.html#installing) 6. Run `pip install -r requirements.txt` to install dependencies 7. [Optionally] run `pip install -r requirements-optional.txt` to install optional dependencies -8. Create new Discord application at https://discord.com/developers/applications +8. Create new Discord application at 9. You can rename it however you want, set needed descriptions etc 10. Go to "Bot" tab and enable application as bot 11. Copy token of your bot 12. Open file `config.json` with your favorite text editor and paste your token as value of "bot_token" key -13. 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. Copy your own Discord ID and paste it as value of "owner" key (How to get ID: ) 14. Bot is ready! Run it using `python yusarin.py` ## Config explanation + Default configuration file is [available here](https://git.profitroll.eu/profitroll/YusarinBot/src/branch/main/config.json) + - "debug" - Option that enables more detailed log messages [Boolean] - "owner" - Discord ID of user who will be able to execute admin commands (`$shutdown` for example) [Integer] - "bot_name" - Name of your bot. Is not used anywhere yet [String] @@ -51,6 +69,7 @@ Default configuration file is [available here](https://git.profitroll.eu/profitr - "auto_clear_timer" - Option that defines how often "auto_clear_trash" will do its job [Integer] ## Extra + 1. Bot doesn't have any self updaters **yet** -2. You can add public version of the bot to your Discord server using this link: https://www.end-play.xyz/yusarin/invite -3. If you have questions/suggestions - just join our [Discord Support Server](https://discord.com/invite/2zpzErtnNT) \ No newline at end of file +2. You can add public version of the bot to your Discord server using this link: +3. If you have questions/suggestions - just join our [Discord Support Server](https://discord.com/invite/2zpzErtnNT)