Skip to content

Commit

Permalink
docs: Add documentation for the playlist plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
Holzhaus committed Feb 15, 2019
1 parent 7eb9866 commit 4d3a6c7
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ like this::
mpdupdate
permissions
play
playlist
plexupdate
random
replaygain
Expand Down Expand Up @@ -158,6 +159,7 @@ Interoperability
* :doc:`mpdupdate`: Automatically notifies `MPD`_ whenever the beets library
changes.
* :doc:`play`: Play beets queries in your music player.
* :doc:`playlist`: Use M3U playlists tp query the beets library.
* :doc:`plexupdate`: Automatically notifies `Plex`_ whenever the beets library
changes.
* :doc:`smartplaylist`: Generate smart playlists based on beets queries.
Expand Down
37 changes: 37 additions & 0 deletions docs/plugins/playlist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Smart Playlist Plugin
=====================

``playlist`` is a plugin to use playlists in m3u format.

To use it, enable the ``playlist`` plugin in your configuration
(see :ref:`using-plugins`).
Then configure your playlists like this::

playlist:
relative_to: ~/Music
playlist_dir: ~/.mpd/playlists

It is possible to query the library based on a playlist by speicifying its
absolute path::

$ beet ls playlist:/path/to/someplaylist.m3u

The plugin also supports referencing playlists by name. The playlist is then
seached in the playlist_dir and the ".m3u" extension is appended to the
name::

$ beet ls playlist:anotherplaylist

Configuration
-------------

To configure the plugin, make a ``smartplaylist:`` section in your
configuration file. In addition to the ``playlists`` described above, the
other configuration options are:

- **playlist_dir**: Where to read playlist files from.
Default: The current working directory (i.e., ``'.'``).
- **relative_to**: Interpret paths in the playlist files relative to a base
directory. It is also possible to set it to ``playlist`` to use the
playlist's parent directory as base directory.
Default: ``library``

0 comments on commit 4d3a6c7

Please sign in to comment.