Readme improvements

master
Ondřej Hruška 6 years ago
parent 99bad0012d
commit 9fb6e3707a
Signed by: MightyPork
GPG Key ID: 2C5FD5035250423D
  1. 50
      README.md

@ -20,59 +20,49 @@ The daemon loads its config from a JSON file, an example of which is provided as
Defaults will be loaded in absence of the config file. Defaults will be loaded in absence of the config file.
Here is the structure explained (please note that JSON doesn't allow comments, Here is the structure explained (please note that JSON doesn't allow comments,
this is just for demonstration): this is just for the demonstration):
``` ```
{ {
// Blacklist config // Blacklist config
"blacklist": { "blacklist": {
// Literal tags to reject // Literal tags to reject
"tag": [], "tag": [],
// Tag sub-strings to reject (must be a whole word) // Tag sub-strings to reject (must be a whole word)
"tag_partial": ["hip-hop", "hip hop", "rap"], "tag_partial": ["hip-hop", "hip hop", "rap"],
// Artists to reject without even checking tags // Artists to reject without even checking tags
"artist": ["Higher Brothers"] "artist": ["Higher Brothers"]
}, },
// Whitelist config // Whitelist config
"whitelist": { "whitelist": {
// Tags to allow despite e.g. a substring match // Tags to allow despite e.g. a substring match
"tag": [], "tag": [],
// Artists to allow unconditionally // Artists to allow unconditionally
"artist": [] "artist": []
}, },
// Logging - trace, debug, (info), warning, error // Logging - trace, debug, (info), warning, error
"logging": "info", // Set to "debug" for more detailed logging (e.g. to see the received
// JSON, or the parsed config file)
// Player names to allow (e.g. when we want to block only Spotify songs) "logging": "info",
// This does not support multiple players playing at once - always only the first is // Player names to allow (e.g. when we want to block only Spotify songs).
// handled. // This does not support multiple players playing at once - always only
// the first is handled.
"allowed_players": [ "allowed_players": [
// spotify player name, as copied from the debug log // spotify player name, as copied from the debug log
// -> Leave this list empty to allow all players! // -> Leave this list empty to allow all players!
"org.mpris.MediaPlayer2.spotify" "org.mpris.MediaPlayer2.spotify"
], ],
// Min MusicBrainz search score for artist look-up // Min MusicBrainz search score for artist look-up
"artist_min_score": 95, "artist_min_score": 95,
// Max nr of artists to check per track (limits MusicBrainz request count) // Max nr of artists to check per track (limits MusicBrainz request count)
"max_artists_per_track": 3, "max_artists_per_track": 3,
// Interval in which the daemon probes DBUS for open MPRIS channels // Interval in which the daemon probes DBUS for open MPRIS channels
"player_find_interval_ms": 2500, "player_find_interval_ms": 2500,
// Delay after a skip or allow, e.g. to prevent infinite skip chain
// Delay after a skip or allow, e.g. to prevent infinite skip // when someone starts a rap playlist and we block the 'rap' tag
// chain when someone starts a rap playlist and we block the 'rap' tag "cooldown_ms": 500,
"cooldown_ms": 500,
// Music Brainz API access timeout // Music Brainz API access timeout
"api_timeout_ms": 2000, "api_timeout_ms": 2000,
// Action to take when the daemon can't figure out if a song is good or not. // Action to take when the daemon can't figure out if a song is good or not.
// Default is true; change to false if you REALLY hate rap, but it will // Default is true; change to false if you REALLY hate rap, but it will
// also block good songs by less known artists. // also block good songs by less known artists.

Loading…
Cancel
Save