github FoxxMD/multi-scrobbler 0.11.0
v0.11.0

9 hours ago

What's New?

Libre.fm Source/Client

Mutli-scrobbler now supports Libre.fm as a Source and Client.

Additionally, if you are running your own Libre.fm instance there are options for defining your own instance as the endpoint.

Musicbrainz Search Improvements

When enhancing your scrobbles with Musicbrainz there are now 1) additional methods for searching and 2) an additional album sorting mechanism to bias matches towards the actual text from your original scrobble.

The order in which searches are executed has also been updated to be fully user-configurable. However, this is a breaking change if you previously had search-related file-config options (fallback*) or are using PRESETS ENV. See Breaking Changes below for how to migrate.

Breaking Changes

Musicbrainz Stage

If you are using the Musicbrainz Stage transformer with any of the following options then you will eventually need to update your config to maintain existing behavior:

  • File Config
    • fallbackAlbumSearch
    • fallbackArtistSearch
    • fallbackFreeTextSearch
  • ENV Config
    • MB_PRESETS

If none of these apply to you no action is required.

If these do apply to you: your existing configuration WILL continue to work but these options have been deprecated and will be removed in a future release. You should still migrate as soon as convenient.

In v0.11.0 Musicbrainz uses a searchOrder list to define the order that search methods are run in. See the Search Methods docs section for more information.

To migrate:

File Config

  • "fallbackAlbumSearch": true replace with "searchOrder": ["album"]
  • "fallbackArtistSearch": "native"
    • replace with "searchOrder": ["artist"]
    • and add "searchArtistMethod": "native" (or naive)
  • "fallbackFreeTextSearch": "true" replace with "searchOrder": ["freetext"]

The directions above assume you are using each option by itself. If you are using more than one then simply combine replacements.

EX using both fallbackFreeTextSearch and fallbackAlbumSearch, replace with "searchOrder": ["album", "freetext"]

You will likely also want to add isrc and basic search methods to the front of your searchOrder, as this emulates the previous MB search behavior:

"searchOrder": ["isrc","basic","album","freetext"]

ENV Config

  • MB_PRESETS=... add default to beginning of your list IE MB_PRESETS=default,native,sensible

Removed Deprecated Jellyfin Source

The old, webhook-based Jellyfin source has been deprecated since v0.8.4 (September 2024). It has not been in the documentation for well over a year. It has now been fully removed.

Removed Deprecated Plex/Tautulli Sources

The old webhook-based Plex and Tautulli (notification agent) Sources have been deprecated since v0.8.7 (October 2024). They have not been in the documentation for well over a year. They have now been fully removed.

Full Changelog

Features

  • (No Category) Librefm Source/Client #401
  • (musicbrainz) Improved missing mbid parsing and tests
  • (musicbrainz) BREAKING: Replace fallback search with searchOrder for more search control
  • (musicbrainz) BREAKING: Improve ENV presets
  • (musicbrainz) Add exclusive search by recording MBID #431 thanks @gabeklavans
  • (musicbrainz) Implement basic-or-ids search
  • (musicbrainz) Implement field scoring
  • (plex) Retrieve MusicBrainz IDs #426 thanks @owendaprile

Bug Fixes

  • (endpointlz) Mark play as new from source
  • (librefm) Log warning for empty account rather than throwing #401
  • (mpd) Add missing MPD envs to source building #432
  • (musicbrainz) Simplify config parsing and log original ids
  • (musicbrainz) Check for release data type before logging #434
  • (tealfm) Don't define brainz artist array if empty
  • (No Category) Move preCompare transform hook for clients to the correct place in lifecycle #435
  • (No Category) Don't mutate original error when merging cause stack for logging
  • (No Category) Remove cache assignment in child class
  • (No Category) Add missing undici dependency #437 thanks @jackwilsdon

Documentation

  • (musicbrainz) Update search methods
  • (No Category) Improve MB docs
  • (No Category) Add read-only install instructions #429 thanks @drake7707
  • (No Category) Re-style details and add custom admonition details component
  • (No Category) Use AdmonitionDetails

Miscellaneous Tasks

  • (No Category) BREAKING: Remove deprecated Jellyfin Source
  • (No Category) BREAKING: Remove deprecated Plex/Tautulli Sources

Testing

  • (lastfm) Improve artist and mbid parsing

Don't miss a new multi-scrobbler release

NewReleases is sending notifications on new releases.