Listenbrainz

This Source monitors a Listenbrainz account’s scrobble history and then re-scrobbles discovered tracks to configured clients.

Other Uses

• To scrobble to a Listenbrainz server, create a Listenbrainz (Client)
• To accept scrobbles from outside applications as if multi-scrobbler was a Listenbrainz server, create a Listenbrainz (Endpoint)

You will need to run your own Listenbrainz server or have an account on the official instance.

On your profile page find your User Token to use in the configuration.

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
SOURCE_LZ_ID	string		A globally unique ID EX myComponentId
SOURCE_LZ_NAME	string	Value of SOURCE_LZ_ID	A vanity name EX My Cool Component
SOURCE_LZ_ENABLE	boolean	true	Should this component be used?
SOURCE_LZ_URL	string	https://api.listenbrainz.org/	URL for the ListenBrainz server, if not using the default
SOURCE_LZ_TOKEN	string		User token for the user to scrobble for
SOURCE_LZ_USER	string		Username of the user to scrobble for
SOURCE_LZ_CONTACT	string		(If running a forked version of multi-scrobbler) A website or email Listenbrainz can contact you at in case of issues

Bold/Italic = Required

File

Config Structure

This displays the structure of the File Configuration for a listenbrainz type Source with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Config Example

This displays an example config file of a listenbrainz Source File Configuration that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuration is correct. Any errors show up as squiggly lines.

Important

Only source listenbrainz configs will validate correctly in the editor but both source and client listenbrainz configs are allowed in the real CONFIG/listenbrainz.json

After you finish editing, switch to text and then copy all text to get a completed config.

configureAs Required

When configuring a listenbrainz Source in a File Config you must set

"configureAs": "source"

Without this property, Multi-Scrobbler will assume the config is for a listenbrainz Client config.

This requirement does not apply to AIO listenbrainz configs.

Config Example Mobile Experience

This displays an example config file of a listenbrainz Source File Configuration that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/listenbrainz.json

[
  {
    "id": "brainzSource",
    "name": "Foxx LZ Source",
    "data": {
      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
      "username": "FoxxMD",
      "url": "https://api.listenbrainz.org"
    },
    "configureAs": "source",
    "enable": true
  }
]

AIO

Config Structure

This displays the structure of the all-in-one (config.json) configuration with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Select the listenbrainz type from the respective sources node below, then expand it.

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a listenbrainz Source that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuraion is correct. Any errors show up as squiggly lines.

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a all-in-one (config.json) configuration that includes a listenbrainz Source that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/config.json

{
  "sources": [
    {
      "type": "listenbrainz",
      "id": "brainzSource",
      "name": "Foxx LZ Source",
      "data": {
        "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
        "username": "FoxxMD",
        "url": "https://api.listenbrainz.org"
      },
      "configureAs": "source",
      "enable": true
    }
  ]
}