Configuration

NOTE: For legacy JSON configuration files, please see Legacy Configuration.

Default Configuration File

# Your Discord bot token (Found at https://discord.com/developers/applications)
botToken: ""

# Your Discord bot client ID
clientId: ""

# Your Genius API client access token (Found at https://genius.com/developers)
geniusApiKey: ""

# The colour to use for embeds sent by the bot
embedColour: "#2B2D31"

# Whether analytics should be sent when starting the bot
# See https://github.com/NerdyTechy/Melody/wiki/Analytics
enableAnalytics: true

# Whether the bot should autocomplete search results
# Disable this if you're experiencing Unknown Interaction errors
enableAutocomplete: true

# Settings to control the bot's player and controller
player:
    # Leave VC when a song ends
    leaveOnEndDelay: 300000 # 5 minutes
    # Leave VC when a song is stopped
    leaveOnStopDelay: 300000 # 5 minutes
    # Leave VC when the channel is empty
    leaveOnEmptyDelay: 300000 # 5 minutes
    # Deafen bot while playing
    deafenBot: false

# Whether the logger should send messages to a Discord webhook
logEventsToWebhook:
    enabled: false
    webhookUrl: ""

# The emojis to be used in buttons for certain embeds
# See https://github.com/NerdyTechy/Melody/wiki/Using-Custom-Emojis
emojis:
    stop: "⏹"
    skip: "⏭"
    queue: "📜"
    pause: "⏯"
    lyrics: "📜"
    back: "⏮"

# Make Melody use a proxy when making requests.
# Useful if you're experiencing 429 errors.
# See https://github.com/NerdyTechy/Melody/wiki/Proxying-Requests
# Omit user:pass@ if your proxy does not require authentication.
proxy:
    enable: false
    connectionUrl: "http://user:[email protected]:8080"

# Make Melody use a custom YouTube cookie when making requests.
# This can help to prevent against receiving 429 rate limits from YouTube.
# See https://github.com/NerdyTechy/Melody/wiki/YouTube-Cookies
cookies:
    useCustomCookie: false
    youtubeCookie: ""

Configuration Options

• botToken - The login token for your bot. This can be found on the Discord Developer Portal.
• clientId - The client ID for your bot. This can be found by inviting your bot to a server, enabling developer mode on Discord (User Settings > Advanced > Developer Mode), and right-clicking on the bot in the server member list.
• geniusApiKey - Your Genius API key. This is used for finding lyrics to songs and can be created here. The key you require is the client access token.
• embedColour - The colour that will be used for all the Discord embeds.
• enableAnalytics - Whether the bot should send anonymous analytics. (Learn more)
• enableAutocomplete - Whether the bot should autocomplete search results when the play and playnext commands are used. Disable this if you are experiencing Unknown Interaction errors.
• player.leaveOnEndDelay - How long the bot should remain in the channel, in milliseconds, when a song ends.
• player.leaveOnStopDelay - How long the bot should remain in the channel, in milliseconds, when a song is stopped.
• player.leaveOnEmptyDelay - How long the bot should remain in the channel, in milliseconds, when the channel that it is playing in is empty.
• player.deafenBot - Whether the bot should show as deafened while playing music.
• emojis.stop - The emoji that will be used for the stop button on certain embeds.
• emojis.skip - The emoji that will be used for the skip button on certain embeds.
• emojis.queue - The emoji that will be used for the queue button on certain embeds.
• emojis.pause - The emoji that will be used for the pause button on certain embeds.
• emojis.lyrics - The emoji that will be used for the lyrics button on certain embeds.
• emojis.back - The emoji that will be used for the back button on certain embeds.
• proxy.enable - Whether Melody should use the request proxy specified.
• proxy.connectionUrl - A connection URL to a HTTP proxy to proxy requests made by Melody to YouTube.
• cookies.useCustomCookie - Whether Melody should use the custom cookie specified in requests.
• cookies.youtubeCookie - The custom cookie Melody should use for YouTube requests. (Learn More)