From bf26e2cc7e6576e5dbc818514256ef213dce8855 Mon Sep 17 00:00:00 2001 From: Carl Suster Date: Tue, 11 Jun 2019 18:34:33 +1000 Subject: [PATCH] docs: mention mpdstats needs to be running Clarify that `mpdstats` is an MPD client and needs to be running all the time to collect statistics. See https://discourse.beets.io/t/mpdstats-requirements/796 --- docs/plugins/mpdstats.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/plugins/mpdstats.rst b/docs/plugins/mpdstats.rst index b769e7468..de9b2ca59 100644 --- a/docs/plugins/mpdstats.rst +++ b/docs/plugins/mpdstats.rst @@ -4,10 +4,14 @@ MPDStats Plugin ``mpdstats`` is a plugin for beets that collects statistics about your listening habits from `MPD`_. It collects the following information about tracks: -* play_count: The number of times you *fully* listened to this track. -* skip_count: The number of times you *skipped* this track. -* last_played: UNIX timestamp when you last played this track. -* rating: A rating based on *play_count* and *skip_count*. +* ``play_count``: The number of times you *fully* listened to this track. +* ``skip_count``: The number of times you *skipped* this track. +* ``last_played``: UNIX timestamp when you last played this track. +* ``rating``: A rating based on ``play_count`` and ``skip_count``. + +To gather these statistics it runs as an MPD client and watches the current state +of MPD. This means that ``mpdstats`` needs to be running continuously for it to +work. .. _MPD: https://www.musicpd.org/