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: "#2F3136"

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

# Settings to control the bot's player and controller
player:
    # Leave VC when a song ends
    leaveUponSongEnd: true
    # Leave VC when a song is stopped
    leaveUponSongStop: true
    # Leave VC after X ms of inactivity
    leaveOnEmptyDelay: 300000 # 5 minutes
    # Deafen bot while playing
    deafenBot: false

# 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: "⏮"

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 of the Discord embeds.
• enableAnalytics - Whether the bot should send anonymous analytics. (Learn more)
• player.leaveUponSongEnd - Whether the bot should leave the VC when the song ends and no others are queued.
• player.leaveUponSongStop - Whether the bot should leave the VC when the stop command is used.
• player.leaveOnEmptyDelay - How long the bot should wait (in ms) before leaving an empty VC.
• 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.