vrr/multi-scrobbler
2
0
Fork 0
mirror of https://github.com/FoxxMD/multi-scrobbler.git synced 2026-04-28 11:49:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add Now Playing and configuration

Browse source
This commit is contained in:
FoxxMD 2025-07-02 20:50:03 +00:00
parent 3cc452323d
commit f885726ed1
2 changed files with 41 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docsite/docs/configuration/configuration.mdx
View file

@ -2327,7 +2327,7 @@ The Callback URL is actually specified by multi-scrobbler but to keep things con
```
http://localhost:9078/lastfm/callback
```
or replace `localhost:9078` with your own base URL
or replace `localhost:9078` with your own base URL.
#### Configuration
@ -2408,6 +2408,45 @@ For Koito, [create an API Key from your Account page.](https://koito.io/guides/s
</TabItem>
</Tabs>
## Now Playing
Multi-scrobbler can report the currently **playing** tracks it is monitoring to some Scrobble Clients via their individual **Now Playing** functionality. The behavior multi-scrobbler uses for determining Now Playing reporting:
* Now Playing will be only be reported to the same Clients a Source is configured to scrobble to
* A Source's Player status must be **Playing**, IE **active**, for reporting to occur
* This status can be verified via Player UI on the Dashboard
* If multiple Sources having active Players then the scrobble Client will default to reporting the track based on Source **configuration** name, alphabetically
* This is the `name` property set in [File or AIO source configs](./?configType=file#configuration-types)
* Now Playing is **default enabled** for all Clients that support it
* Now Playing can be explicitly enabled or disabled globally using ENV `NOW_PLAYING=true` or `NOW_PLAYING=false`
* This only affects Clients that don't have behavior set via File/AIO (below)
Clients can customize the Now Playing behavior individually using [File or AIO source configs:](./?configType=file#configuration-types)
```json5 title="CONFIG_DIR/lastfm.json"
[
{
"name": "myLastFmClient",
"configureAs": "client",
"data": {
// ...
},
"options": {
// disable or enable
//"nowPlaying": true
//
// OR define a list of Source *config* names that should be allowed to report Now Playing
//"nowPlaying": ["mySpotify1","myJellyfin2"]
}
},
]
```
### Supported Scrobble Clients
* [Last.fm](#lastfm)
* More coming soon
## Monitoring
multi-scrobbler supports some common webhooks and a healthcheck endpoint in order to monitor Sources and Clients for errors.