Environment Variables
ChadMusic utilizes environment variables for certain configurations. Bundled with the bot is a .env.example file that you can use set your configurations to. Once you're finished editing the file, you will need to rename it to .env so the bot can read and use the configurations you set during boot. Changing any of the values during the bot's runtime will not be applied until the bot has been rebooted.
In the case where you want to create your own .env file instead, provided below are all the variables that the bot uses. Not every single value is listed on this page, such as the variables used to manage the bot's user interface. If you want to change the bot's user interface, please go to Configuration > Customization for more information.
Client Configuration
TOKEN
This field is required.
Your bot's token.
PREFIX
The default prefix for your bot to respond to. Does not apply to slash commands.
Info
If no prefix is provided, then your bot's mention will be used as a prefix instead.
OWNER_ID
Your user ID. This is the unique ID that is attached to your Discord account and can only be retrieved by using developer mode. You must provide this for the bot to recognize you as the owner.
APP_ID
This field is required.
Your application's user ID. This is needed to sync any slash commands on your bot to Discord.
PUBLIC_KEY
Your application's public key. This is also needed to sync any slash commands on your bot to Discord. Your bot's public key and can be fetched from your app's developer page.
Sharding
SHARDING
Enables sharding the bot. This should only be used for large bots that are in over 2500 guilds. When enabled, you must send a SIGINT signal if you want to completely shut down the bot. Using the shutdown command restarts all shards instead.
Info
Sharding the bot isn't necessary until your bot reaches 2500 guilds.
SHARDS
Requires SHARDING variable.
The number of shards to use. This splits the bot into multiple processes to ease the load of a single shard. Disable to have the bot spawn shards automatically.
SHARDS_PER_CLUSTER
Requires SHARDING variable.
The number of shards that a single cluster will utilize. Clusters are shards that spawn their own internal shards to reduce memory usage. Learn more
Player Configuration
YOUTUBE_COOKIE
This field is deprecated. Learn more.
The cookie to use from YouTube. This is optional but recommended to use. To learn how to get a cookie header, you can look at the example from here. It tells you how to get the cookie header. Once you have what you need, paste the entire content in this variable.
IPV6_BLOCK
A IPv6 range block address for IP rotation. If you have a IPv6 range, you can use it in this field. This will alleviate the need for a cookie. If you do not know how to use this field, or you don't have an active IPv6 range added to your host, you can leave this field empty and provide a cookie instead.
Info
An address with a prefix size of /64 is recommended, and is usually the most common address assigned by many hosting providers.
USE_YOUTUBE_DL
Enables youtube-dl. Set to true to allow the bot to use any website supported by youtube-dl. Defaults to true.
UPDATE_YOUTUBE_DL
Allows the bot to download the most recent build of youtube-dl on boot. Defaults to true. Do not use this variable if you utilize a custom build.
SPOTIFY_EMIT_EVENTS_AFTER_FETCHING
For Spotify playlists, this field dictates whether the bot should run player events after fetching all songs in a playlist or not. This field is disabled, or false by default. Set to true to enable this field.
SPOTIFY_PARALLEL
For Spotify, this field dictates whether the bot should search for all tracks in parallel or not. This field is enabled by default. If searching in parallel, the bot will search for all tracks at the same time. If this field is disabled, then all tracks will be searched one link at a time.
GENIUS_TOKEN
The token to access Genius API for song lyrics. If this variable is unused, scraping will be used instead.
Development
DEV_GUILD
The guild's ID. Enabling this will turn the bot's commands into guild commands for the specified guild. Do not use this varibale to make the commands global.
USE_EVAL
Enables the eval command. With great power comes great responsibility.
Danger
Eval can be dangerous if used improperly. You should not enable this variable, unless you know exactly what you're doing. If someone is telling you to enable the eval command to run something, you're most likely being scammed!
USE_CONSOLE
Allows the bot to log to the console window.
DEBUG_LOGGING
Enables debug logging. Useful for reporting bugs.
DELETE_INVALID_COMMANDS
Deletes any slash commands that are no longer valid to the bot. Do not use this variable if you have multiple programs controlling one bot account.
Adding Cookies
Starting in 2023.5.0, a new cookie system has been implemented replacing the YOUTUBE_COOKIE variable. This method should be easier to implement for your use case, but is completely optional. Also, with the new cookie system, you're not just limited to one cookie. The new system will allow you to use more than one cookie! You can learn more on how to use the new cookie system by following the guide below.
By completing the guide for the new cookie system, you should now have the generated cookie, or multiple cookies if you have more than one. You will need to add them all to the cookies.json file located within the root directory of your bot.