Music Assistant Companion

The desktop companion app for Music Assistant!
Music Assistant »

Download for macOS (Apple Silicon | Intel) · Windows · Linux (Debian | Other)

Important

This is still in very early alpha. Bugs will be present. Please help finding them, you can report any bugs on the Discord server or in the repo issues

Warning

LOOKING FOR MAINTAINERS. The companion app is current very sparsly maintained. Any help is appreciated. Check out the CONTRIBUTING.md file if you want to help.

Setup

When starting the app for the first time you are asked about some information about the Music Assistant Server.

Important

The app requires that the webserver is exposed. You can set that in the settings:

Features

Squeezelite

Squeezelite comes embedded in the application. This allows playback of music to your computer. The player name will be the same as your computer name. You can change the name in Music Assistant settings. You can also toggle if you wish to enable squeezelite at all.

To allow playback to the companion app you have to enable the slimproto provider in the Music Assistant settings.

Discord Rich Presence

Like the Spotify app, the Music Assistant app can do Discord Rich Presence.

Example of Discord Rich Presence:

Installation

Windows

You can download the .msi installer from the releases.

MacOS

You can download the .dmg from the releases.

Or you can download it using homebrew: brew install music-assistant/tap/companion

Arch Linux

This app is on the arch aur with the name music-assistant-desktop or music-assistant-desktop-bin for just the binary

You can install it with yay: yay music-assistant-desktop-bin

Debian (And debian based distrobutions)

You can download the .deb from the releases.

All the other linux distros

You can download the AppImage from the releases.

From source

If you wish to build the app yourself you should first follow the offical tauri prerequisites

Next, make sure you have the frontend submodule cloned. You can do this by running the following command:

git submodule --init --recursive

Then clone the repository and install the node dependencies

$ git clone https://github.com/music-assistant/music-assistant-desktop --recursive
$ cd music-assistant-desktop
$ yarn install
$ cd frontend
$ yarn install
$ cd ..

And then build the app

$ npx tauri build

Contributing

Check the CONTRIBUTING.md file.