Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FoxxMD/multi-scrobbler

Scrobble plays from multiple sources to multiple clients
https://github.com/FoxxMD/multi-scrobbler

deezer docker jellyfin kodi lastfm listenbrainz maloja mopidy mpris music plex scrobble self-hosted spotify subsonic tautulli youtube-music

Last synced: 4 days ago
JSON representation

Scrobble plays from multiple sources to multiple clients

Awesome Lists containing this project

README 

        
# multi-scrobbler



[![Latest Release](https://img.shields.io/github/v/release/foxxmd/multi-scrobbler)](https://github.com/FoxxMD/multi-scrobbler/releases)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)](https://hub.docker.com/r/foxxmd/multi-scrobbler)

[![Docs](https://img.shields.io/badge/Read%20The%20Docs-1082c2)](https://foxxmd.github.io/multi-scrobbler/)



multi-scrobbler logo



A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), and [ListenBrainz](https://listenbrainz.org)



* Supports scrobbling from many **Sources**

  * [Spotify](https://foxxmd.github.io/multi-scrobbler/docs/configuration#spotify)

  * [Plex](https://foxxmd.github.io/multi-scrobbler/docs/configuration#plex) or [Tautulli](https://foxxmd.github.io/multi-scrobbler/docs/configuration#tautulli)

  * [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/docs/configuration#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))

  * [Jellyfin](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jellyfin)

  * [WebScrobbler](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webscrobbler)

  * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/docs/configuration#youtube-music)

  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source)

  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source)

  * [~~Deezer~~](https://foxxmd.github.io/multi-scrobbler/docs/configuration#deezer)

  * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris)

  * [Mopidy](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mopidy)

  * [JRiver](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jriver)

  * [Kodi](https://foxxmd.github.io/multi-scrobbler/docs/configuration#kodi)

  * [Google Cast (Chromecast)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#google-cast-chromecast)

  * [Musikcube](https://foxxmd.github.io/multi-scrobbler/docs/configuration#muikcube)

  * [MPD (Music Player Daemon)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpd-music-player-daemon)

  * [VLC](https://foxxmd.github.io/multi-scrobbler/docs/configuration#vlc)

* Supports scrobbling to many **Clients**

  * [Maloja](https://foxxmd.github.io/multi-scrobbler/docs/configuration#maloja)

  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm)

  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz)

* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webhook-configurations) or [healthcheck endpoint](https://foxxmd.github.io/multi-scrobbler/docs/configuration#health-endpoint)

* Supports configuring for single or multiple users (scrobbling for your friends and family!)

* Web server interface for stats, basic control, and detailed logs

* Graceful network and client failure handling (queued scrobbles that auto-retry)

* Smart handling of credentials (persistent, authorization through app)

* Easy configuration through ENVs or JSON

* Modify data before scrobbling with [regular expression or search patterns](https://foxxmd.github.io/multi-scrobbler/docs/transforms)

* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker), [flatpak](https://foxxmd.github.io/multi-scrobbler/docs/installation#flatpak), or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/docs/installation#nodejs)



[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)






**Why should I use this over a browser extension and/or mobile app scrobbler?**



* **Platform independent** -- Because multi-scrobbler communicates directly with service APIs it will scrobble everything you play regardless of where you play it. No more need for apps on every platform you use!

* **Open-source** -- Get peace of mind knowing exactly how your personal data is being handled.

* **Track your activity regardless of where you listen** -- Scrobble from many Sources to one Client with ease and without duplicating tracks.

* **Manage scrobbling for others** -- Scrobble for your friends and family without any setup on their part. Easily silo sources to specific clients to keep plays separate.



**But I already scrobble my music to Last.fm/ListenBrainz, is multi-scrobbler for me?**



Yes! You can use [Last.fm as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source) or [Listenbrainz as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location.



## How Does multi-scrobbler (MS) Work?



You set up configurations for one or more **Sources** and one or more **Clients**. MS monitors all of your configured **Sources**. When new tracks are played by a Source it grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to scrobble to.



### Source



A **Source** is a data source that contains information about tracks you are playing like a music player or platform. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Airsonic**, etc...



Source configurations consist of:



* A friendly name.

* Any data needed to communicate or authenticate with the Source.

* An optional list of Client names that the Source should scrobble to. If omitted the Source also scrobbles to all configured Clients.



### Client



A **Client** is an application that stores the historical information about what songs you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...



Client configurations consist of:



* A friendly name.

* Any data needed to communicate or authenticate with the Client.



## Quick Start



[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)



## Installation



[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/docs/installation)



## Configuration



[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration)



## Usage



A status page with statistics, recent logs, and some runtime configuration options can be found at



```

http://localhost:9078

```

Output is also provided to stdout/stderr as well as file if specified in configuration.



On first startup you may need to authorize Spotify and/or Last.fm by visiting the callback URL (which can also be accessed from the status page). Visit the status page above to find the applicable link to trigger this.



## Help/FAQ



Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ) before creating an issue!



## Development



[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/docs/development/dev-common)



## License



MIT