mirror of
https://github.com/RafaelSolVargas/Vulkan.git
synced 2025-10-29 16:57:23 +00:00
chore(.env.example): add example .env file with configurable settings
docs(DOCKER.md): add instructions for running the bot in a Docker container docs(SETTINGS.md): update instructions for changing bot settings in .env file docs(README.md): update instructions for running the bot and add Docker instructions
This commit is contained in:
10
README.md
10
README.md
@@ -62,16 +62,17 @@ You can download the executables in this link `https://www.ffmpeg.org/download.h
|
||||
|
||||
### **.Env File Example**
|
||||
This is an example of how your .env file (located in root) should look like.
|
||||
```
|
||||
```env
|
||||
BOT_TOKEN=Your_Own_Bot_Token
|
||||
SPOTIFY_ID=Your_Own_Spotify_ID
|
||||
SPOTIFY_SECRET=Your_Own_Spotify_Secret
|
||||
BOT_PREFIX=Your_Wanted_Prefix_For_Vulkan
|
||||
|
||||
SHOULD_AUTO_DISCONNECT_WHEN_ALONE=True #all settings can be set like this
|
||||
#etc... All settings can be set this way
|
||||
```
|
||||
|
||||
### **⚙️ Configs**
|
||||
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. <br>
|
||||
The bot's configuration is stored in the [.env](.env) file, you can change the prefix and the bot token there, as well as all the other configurations.
|
||||
Take a look in the [Settings page](.github/Docs/SETTINGS.md) to personalize the Bot for you.
|
||||
|
||||
|
||||
@@ -80,6 +81,9 @@ Take a look in the [Settings page](.github/Docs/SETTINGS.md) to personalize the
|
||||
- Run ```python main.py``` in console to start
|
||||
- Give this project a nice 🌟
|
||||
|
||||
### **🐳 Docker**
|
||||
You can also run this project in a Docker container. You can find the instructions to run this project in a Docker container in the [Docker Instructions](.github/Docs/DOCKER.md) page.
|
||||
|
||||
|
||||
<br>
|
||||
<hr>
|
||||
|
||||
Reference in New Issue
Block a user