mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
docs: Add documentation for the playlist plugin
This commit is contained in:
parent
19b92e1199
commit
cc501be2d9
2 changed files with 39 additions and 0 deletions
|
|
@ -81,6 +81,7 @@ like this::
|
||||||
mpdupdate
|
mpdupdate
|
||||||
permissions
|
permissions
|
||||||
play
|
play
|
||||||
|
playlist
|
||||||
plexupdate
|
plexupdate
|
||||||
random
|
random
|
||||||
replaygain
|
replaygain
|
||||||
|
|
@ -158,6 +159,7 @@ Interoperability
|
||||||
* :doc:`mpdupdate`: Automatically notifies `MPD`_ whenever the beets library
|
* :doc:`mpdupdate`: Automatically notifies `MPD`_ whenever the beets library
|
||||||
changes.
|
changes.
|
||||||
* :doc:`play`: Play beets queries in your music player.
|
* :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
|
* :doc:`plexupdate`: Automatically notifies `Plex`_ whenever the beets library
|
||||||
changes.
|
changes.
|
||||||
* :doc:`smartplaylist`: Generate smart playlists based on beets queries.
|
* :doc:`smartplaylist`: Generate smart playlists based on beets queries.
|
||||||
|
|
|
||||||
37
docs/plugins/playlist.rst
Normal file
37
docs/plugins/playlist.rst
Normal file
|
|
@ -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``
|
||||||
Loading…
Reference in a new issue