https://github.com/grantbirki/muse

self-hosted and dockerized Discord bot for playing music
https://github.com/grantbirki/muse

discord muse music self-hosted

Last synced: 3 months ago
JSON representation

self-hosted and dockerized Discord bot for playing music

• Host: GitHub
• URL: https://github.com/grantbirki/muse
• Owner: GrantBirki
• License: mit
• Created: 2023-12-02T19:17:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-14T05:10:04.000Z (6 months ago)
• Last Synced: 2025-07-30T12:31:23.359Z (3 months ago)
• Topics: discord, muse, music, self-hosted
• Language: Shell
• Homepage:
• Size: 197 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# muse 🎧

[![deploy](https://github.com/GrantBirki/muse/actions/workflows/deploy.yml/badge.svg)](https://github.com/GrantBirki/muse/actions/workflows/deploy.yml) [![Unlock On Merge](https://github.com/GrantBirki/muse/actions/workflows/unlock-on-merge.yml/badge.svg)](https://github.com/GrantBirki/muse/actions/workflows/unlock-on-merge.yml)

A self-hosted version of [muse](https://github.com/codetheweb/muse).

## Commands 💻

Here is a table of all commands that are available to use:

> Note: Many commands have optional arguments. View more details about a command by starting to type the command

| Command | Description |

| ------- | ----------- |

| `/play ` | Play a song or playlist from YouTube or Spotify |

| `/next` | Skip to the next song |

| `/stop` | Stop playback, disconnect, and clear all songs in the queue |

| `/clear` | Clears all songs in the queue except the currently playing song |

| `/now-playing` | Show the currently playing song |

| `/disconnect` | Pause and disconnect |

| `/favorites create` | Create a new favorite |

| `/favorites list` | List all favorites |

| `/favorites remove` | Removes a favorite |

| `/favorites use` | Favorites use |

| `/fseek ` | Seek forward to a time in the current song |

| `/loop` | Toggle looping of the current song |

| `/move  ` | Move songs within the queue |

| `/queue` | Show the current queue |

| `/remove ` | Remove songs from the queue |

| `/replay` | Replay the current song |

| `/resume` | Resume playback |

| `/seek ` | Seek to a position from the begining of the song |

| `/shuffle` | Shuffle the current queue |

| `/skip` | Skip the next song or songs depending on your inputs |

| `/unskip` | Go back in the queue by one song |

| `/volume` | Change the volume of the bot |

| `/config set-default-volume` | Set the default volume of the bot | 

| `/config set-auto-announce-next-song True` | Set *auto-announce* on new tracks in your voice channel during the transition to a new track |

## Features ⭐

- 🎥 Livestreams

- ⏩ Seeking within a song/video

- 💾 Local caching for better performance

- 📋 No vote-to-skip - this is anarchy, not a democracy

- ↔️ Autoconverts playlists / artists / albums / songs from Spotify

- ↗️ Users can add custom shortcuts (aliases)

- 🔊 Normalizes volume across tracks

## Updating 📦

To update the version that is deployed, do the following:

- Go to the upstream [releases page](https://github.com/codetheweb/muse/releases) and find the latest version (e.g. `v2.4.3`)

- Open the [`docker-compose.yml`](./docker-compose.yml) file and change the `image` field of the `muse` service to the new version (e.g. `codetheweb/muse:2.4.3`) - note: we leave out the `v` prefix here

- Open a pull request with your changes

- Once approved, comment `.deploy` on your PR to deploy the new version to production

- If all goes well, merge the pull request

- ✅ Done!