README.md

Music Assistant Companion

The desktop companion app for Music Assistant!
Music Assistant »

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

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:

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

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

First, clone the repository and install the node dependencies. You can do this by running the following commands:

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

And then build the app

$ yarn tauri build

Contributing

Check the CONTRIBUTING.md file

---