Listenbrainz

Other Users

• To monitor and re-scrobble activity from a Listenbrainz account create a Listenbrainz (Source)
• 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
LZ_ID	string		A globally unique ID EX myComponentId
LZ_NAME	string	Value of LZ_ID	A vanity name EX My Cool Component
LZ_ENABLE	boolean	true	Should this component be used?
LZ_URL	string	https://api.listenbrainz.org/	URL for the ListenBrainz server, if not using the default
LZ_TOKEN	string		User token for the user to scrobble for
LZ_USER	string		Username of the user to scrobble for

Bold/Italic = Required

File

Config Structure

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

Loading ...

Config Example

This displays an example config file of a listenbrainz Client 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 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 listenbrainz Client 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

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

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 clients node below, then expand it.

Loading ...

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a listenbrainz Client 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 Client 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

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