mirror of
https://github.com/RafaelSolVargas/Vulkan.git
synced 2025-10-29 16:57:23 +00:00
Updating readme
This commit is contained in:
25
.github/Docs/HEROKU.md
vendored
Normal file
25
.github/Docs/HEROKU.md
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
<h1 align="center">Configuring Heroku</h1>
|
||||
|
||||
> Heroku doesn't offer free services anymore
|
||||
|
||||
Nobody wants to run the Vulkan process on their machine, so we host the process on Heroku, <s>a cloud platform that contains free</s>.<br>
|
||||
To configure the Vulkan to run in your Heroku account you will need to:
|
||||
|
||||
- Create an application project in Heroku.
|
||||
- Configure the environment variables in your application.
|
||||
- Add these buildpacks to your application:
|
||||
|
||||
```
|
||||
- heroku/python
|
||||
- https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git
|
||||
- https://github.com/xrisk/heroku-opus.git
|
||||
```
|
||||
The order shown above is exactly the upside-down order that Buildpacks should appear in Heroku.
|
||||
- Set the heroku stack to be `heroku-20`. <br>
|
||||
As shown in this issue: [Issue](https://github.com/RafaelSolVargas/Vulkan/issues/25) the heroku-buildpack doesn't work properly with the heroku application Stack set as above `heroku-20`.
|
||||
|
||||
<br>
|
||||
|
||||
This [Youtube Video](https://www.youtube.com/watch?v=BPvg9bndP1U&ab_channel=TechWithTim) shows the process of hosting a Bot in Heroku.
|
||||
|
||||
You can also fork this project and set in Heroku to your application automatically deploy when your project receive a new commit, and then control when new versions of Vulkan become available to your Bot.
|
||||
38
.github/Docs/SETTINGS.md
vendored
Normal file
38
.github/Docs/SETTINGS.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
<h1 align="center">Settings</h1>
|
||||
|
||||
|
||||
## 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: <br>
|
||||
- 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: <br>
|
||||
- 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: <br>
|
||||
- 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: <br>
|
||||
- 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: <br>
|
||||
- Change the property MAX_SONGS_IN_PAGE of the VConfigs class to what you want to.
|
||||
Reference in New Issue
Block a user