Skip to content

Configuration

vlOd edited this page May 26, 2024 · 8 revisions

Configuration

This page contains information about everything to know about config.yml (the configuration file)

Introduction

Unlike previous revisions of PYMusicBot, V2 doesn't need any configuration to properly work!
However, it's very likely that you will need to configure PYMusicBot, as the initial configuration is pretty bare bones

Syntax

PYMusicBot V2 (unlike V1) uses YAML
The syntax is very human friendly and designed to be easy to use
You can reference this for more details

Entry explanations

AdminRoles

The roles which are classified as administrators (PYMusicBot ones)
By default, this entry is empty

AdminUsers

The user IDs which are classified as administrators (PYMusicBot ones)
By default, this entry is empty

BannedChannels

The channel IDs which are disallowed from starting player instances in
By default, this entry is empty

BannedUsers

The user IDs which are prohibited from using any commands (the commands will time out)
By default, this entry is empty

FlipURLHostWhitelist

Value that indicates if URLHostWhitelist acts as a blacklist instead of a whitelist
By default, this entry is set to false

PresenceText

Value that is used for the bot's presence (playing status)
By default, this entry is set to music to you!

URLHostWhitelist

A list containing regex paterns of the allowed hostnames to play from
By default, this entry is set to

- youtube.com
- '*.youtube.com'
- youtu.be
- cdn.discordapp.com

YTDLPExtractors

A list containing all the extractors to use from yt-dlp
You can find a full list of all extractors here

Warning

Make sure to not include the IE part at the end

Caution

It is not recommended to include a lot of extractors, as it will dramatically increase play times, sometimes causing time outs

Important

Playlists are currently not supported, so DO NOT INCLUDE YoutubePlaylistIE NOR YoutubeTabIE

By default, this entry is set to

- Youtube
- YoutubeYtBe
- YoutubeTruncatedID
- YoutubeTruncatedURL
- YoutubeConsentRedirect
- YoutubeSearch
- Generic