From 47cb9ec8f5646aa6a35900f8b3ef6d1b56fccf35 Mon Sep 17 00:00:00 2001 From: Rafael Vargas Date: Mon, 20 Feb 2023 02:58:41 -0300 Subject: [PATCH] Updating readme --- HEROKU.md => .github/Docs/HEROKU.md | 0 .github/Docs/SETTINGS.md | 38 +++++++++++++++++++++++++++++ README.md | 18 ++++++-------- 3 files changed, 46 insertions(+), 10 deletions(-) rename HEROKU.md => .github/Docs/HEROKU.md (100%) create mode 100644 .github/Docs/SETTINGS.md diff --git a/HEROKU.md b/.github/Docs/HEROKU.md similarity index 100% rename from HEROKU.md rename to .github/Docs/HEROKU.md diff --git a/.github/Docs/SETTINGS.md b/.github/Docs/SETTINGS.md new file mode 100644 index 0000000..b7af533 --- /dev/null +++ b/.github/Docs/SETTINGS.md @@ -0,0 +1,38 @@ +

Settings

+ + +## Important Parameters +- Bot Prefix +- Auto Disconnect When Alone +- Specific Process for each Player +- Maximum songs downloading at a time +- Maximum songs in a Queue Page + +All parameters can be modified in the Configs.py file that are located in the Config folder +> The path to the file is ./Config/Configs.py + + +### **Bot Prefix** +The Bot Prefix is just a string that must be passed as prefix when calling any Bot command from the Discord. +To change that you must:
+- Change the property BOT_PREFIX of the VConfigs class to what prefix you want to. + +### **Auto Disconnect** +As a result of the [Issue 33](https://github.com/RafaelSolVargas/Vulkan/issues/33) you can configure if the Bot will auto disconnect when being alone in the voice channel. The default configuration is to disconnect within 300 seconds if it finds out no one is currently listing to it. +To change that you must:
+- Change the property SHOULD_AUTO_DISCONNECT_WHEN_ALONE of the VConfigs class to False + +### **Multiprocessing or Threading** +As a result of the [Issue 35](https://github.com/RafaelSolVargas/Vulkan/issues/35) you can configure if the Bot will create a specific Python Process for each Player (Guild) that he is playing songs or all will happen in the Main Process. The Default behavior is to create a new process. +To change that you must:
+- Change the property SONG_PLAYBACK_IN_SEPARATE_PROCESS of the VConfigs class to False + +### **Maximum Downloading Quant** +The download of songs can be very fast or very slow, the faster it is the slower the response time for any command (during the download) is higher, (including the playback quality), because there will be a Task for each song. But it's possible to set up this variable to slow the download and keep the response time better. +To change that you must:
+- Change the property MAX_DOWNLOAD_SONGS_AT_A_TIME of the VConfigs class to what you want to. + +### **Maximum Songs In Queue Page** +When the ```Queue``` command is called, the current song playlist is presented in the Discord, you can configure how many songs you will want to show in each page. +To change that you must:
+- Change the property MAX_SONGS_IN_PAGE of the VConfigs class to what you want to. \ No newline at end of file diff --git a/README.md b/README.md index 66ef148..4a89b2d 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,10 @@ Vulkan uses multiprocessing and asynchronous Python modules to maximize Music Pl

+
+
-# **How to use it** +## **Setting up for yourself** ### **Requirements** @@ -69,29 +71,25 @@ BOT_PREFIX=Your_Wanted_Prefix_For_Vulkan ``` ### **โš™๏ธ Configs** -The config file is located at ```./config/Configs.py```, it doesn't require any change, but if you can change values to the way you want.
+The config file is located at ```./config/Configs.py```, it doesn't require any change, but if you can change the values to the way you want.
+Take a look in the [Settings page](.github/Docs/SETTINGS.md) to personalize the Bot for you. ### **Initialization** - Go to [Discord](https://discord.com/developers) and invite your Bot to your own server - Run ```python main.py``` in console to start - - -### **Configuring Auto Disconnect** -As a result of the [Issue 33](https://github.com/RafaelSolVargas/Vulkan/issues/33) now you can configure if the Bot will auto disconnect when being alone in the voice channel, the default configuration is to disconnect within 300 seconds if it finds out no one is currently listing to it. -To change that you must:
-- Change the property SHOULD_AUTO_DISCONNECT_WHEN_ALONE of the VConfigs class to False -> The path to the file is ./Config/Configs.py +- Give this project a nice ๐ŸŒŸ

+ ## **๐Ÿš€ Heroku (Not free anymore)** > *Heroku doesn't offer free host services anymore.*
-To deploy and run your Bot in Heroku 24/7, follow the instructions in the [Heroku Instructions](HEROKU.md) page. +To deploy and run your Bot in Heroku 24/7, follow the instructions in the [Heroku Instructions](.github/Docs/HEROKU.md) page. ## ๐Ÿงช Tests The tests were written manually with no package due to problems with async function in other packages, to execute them type in root: