a self-hosted midwestern Discord music bot that doesn't suck
a self-hosted midwestern Discord music bot that doesn't suck
[!IMPORTANT] Muse is now community-maintained under the
museofficialorganization. For Docker, useghcr.io/museofficial/museas the canonical image source. Docker Hub tags may be published as compatibility mirrors, but GHCR is the supported target for new deployments.
Muse is a highly-opinionated midwestern self-hosted Discord music bot that doesn't suck. It's made for small to medium-sized Discord servers/guilds (think about a group the size of you, your friends, and your friend's friends).
Muse is written in TypeScript. You can either run Muse with Docker (recommended) or directly with Node.js. Both methods require the Discord and YouTube API keys below. Spotify keys are optional and enable Spotify URL conversion:
DISCORD_TOKEN can be acquired here by creating a 'New Application', then going to 'Bot'.SPOTIFY_CLIENT_ID and SPOTIFY_CLIENT_SECRET can be acquired here with 'Create a Client ID'.YOUTUBE_API_KEY can be acquired by creating a new project in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.Muse will log a URL when run. Open this URL in a browser to invite Muse to your server. Muse will DM the server owner after it's added with setup instructions.
A 64-bit OS is required to run Muse.
The master branch acts as the developing / bleeding edge branch and is not guaranteed to be stable.
When running a production instance, I recommend that you use the latest release.
There are a variety of image tags available:
:2: versions >= 2.0.0:2.1: versions >= 2.1.0 and -yt-dlp-`.Muse can skip non-music segments at the beginning or end of a Youtube music video (Using SponsorBlock). It is disabled by default. If you want to enable it, set the environment variable ENABLE_SPONSORBLOCK=true or uncomment it in your .env.
Being a community project, the server may be down or overloaded. When it happen, Muse will skip requests to SponsorBlock for a few minutes. You can change the skip duration by setting the value of SPONSORBLOCK_TIMEOUT.
In the default state, Muse has the status "Online" and the text "Listening to Music". You can change the status through environment variables:
BOT_STATUS:
online (Online)idle (Away)dnd (Do not Disturb)BOT_ACTIVITY_TYPE:
PLAYING (Playing XYZ)LISTENING (Listening to XYZ)WATCHING (Watching XYZ)STREAMING (Streaming XYZ)BOT_ACTIVITY: the text that follows the activity type
BOT_ACTIVITY_URL If you use STREAMING you MUST set this variable, otherwise it will not work! Here you write a regular YouTube or Twitch Stream URL.
Muse is watching a movie and is DND:
BOT_STATUS=dndBOT_ACTIVITY_TYPE=WATCHINGBOT_ACTIVITY=a movieMuse is streaming Monstercat:
BOT_STATUS=onlineBOT_ACTIVITY_TYPE=STREAMINGBOT_ACTIVITY_URL=https://www.twitch.tv/monstercatBOT_ACTIVITY=MonstercatIf you have Muse running in a lot of guilds (10+) you may want to switch to registering commands bot-wide rather than for each guild. (The downside to this is that command updates can take up to an hour to propagate.) To do this, set the environment variable REGISTER_COMMANDS_ON_BOT to true.
You can configure the bot to automatically turn down the volume when people are speaking in the channel using the following commands:
/config set-reduce-vol-when-voice true - Enable automatic volume reduction/config set-reduce-vol-when-voice false - Disable automatic volume reduction/config set-reduce-vol-when-voice-target - Set the target volume percentage when people speak (0-100, default is 20)No open issues yet, or sync has not completed.