beets/docs/plugins/mpdupdate.rst
2025-08-10 16:25:05 +01:00

38 lines
1.3 KiB
ReStructuredText

MPDUpdate Plugin
================
``mpdupdate`` is a very simple plugin for beets that lets you automatically
update MPD_'s index whenever you change your beets library.
.. _mpd: https://www.musicpd.org/
To use ``mpdupdate`` plugin, enable it in your configuration (see
:ref:`using-plugins`). Then, you'll probably want to configure the specifics of
your MPD server. You can do that using an ``mpd:`` section in your
``config.yaml``, which looks like this:
::
mpd:
host: localhost
port: 6600
password: seekrit
With that all in place, you'll see beets send the "update" command to your MPD
server every time you change your beets library.
If you want to communicate with MPD over a Unix domain socket instead over TCP,
just give the path to the socket in the filesystem for the ``host`` setting.
(Any ``host`` value starting with a slash or a tilde is interpreted as a domain
socket.)
Configuration
-------------
The available options under the ``mpd:`` section are:
- **host**: The MPD server name. Default: The ``$MPD_HOST`` environment variable
if set, falling back to ``localhost`` otherwise.
- **port**: The MPD server port. Default: The ``$MPD_PORT`` environment variable
if set, falling back to 6600 otherwise.
- **password**: The MPD server password. Default: None.