Skip to content

Commit

Permalink
docs: mention Beetstream and webrouter plugins
Browse files Browse the repository at this point in the history
Also, moves the webm3u plugin link from tne interoperability section to the "Other Plugins" section of the documentation.
  • Loading branch information
mgoltzsche committed Apr 13, 2024
1 parent 883bbb3 commit 3c6309f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
21 changes: 15 additions & 6 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ Interoperability
Automatically notifies `Subsonic`_ whenever the beets
library changes.

`webm3u`_
Serves the (:doc:`smartplaylist <smartplaylist>` plugin generated) M3U
playlists via HTTP.

.. _AURA: https://auraspec.readthedocs.io
.. _Emby: https://emby.media
Expand All @@ -324,7 +321,6 @@ Interoperability
.. _Kodi: https://kodi.tv
.. _Sonos: https://sonos.com
.. _Subsonic: http://www.subsonic.org/
.. _webm3u: https://github.com/mgoltzsche/beets-webm3u

Miscellaneous
-------------
Expand Down Expand Up @@ -438,7 +434,9 @@ Here are a few of the plugins written by the beets community:
Enables **bandcamp.com** autotagger with a fairly extensive amount of metadata.

`beetstream`_
Is server implementation of the `SubSonic API`_ specification, allowing you to stream your music on a multitude of clients.
Server implementation of the `Subsonic API`_ specification, serving the
beets library and (:doc:`smartplaylist <smartplaylist>` plugin generated)
M3U playlists, allowing you to stream your music on a multitude of clients.

`beets-bpmanalyser`_
Analyses songs and calculates their tempo (BPM).
Expand Down Expand Up @@ -512,6 +510,15 @@ Here are a few of the plugins written by the beets community:
`beets-usertag`_
Lets you use keywords to tag and organize your music.

`beets-webm3u`_
Serves the (:doc:`smartplaylist <smartplaylist>` plugin generated) M3U
playlists via HTTP.

`beets-webrouter`_
Serves multiple beets webapps (e.g. :doc:`web <web>`, `beets-webm3u`_,
`beetstream`_, :doc:`aura <aura>`) using a single command/process/host/port,
each under a different path.

`whatlastgenre`_
Fetches genres from various music sites.

Expand All @@ -533,7 +540,7 @@ Here are a few of the plugins written by the beets community:
.. _beets-barcode: https://github.com/8h2a/beets-barcode
.. _beetcamp: https://github.com/snejus/beetcamp
.. _beetstream: https://github.com/BinaryBrain/Beetstream
.. _SubSonic API: http://www.subsonic.org/pages/api.jsp
.. _Subsonic API: http://www.subsonic.org/pages/api.jsp
.. _beets-check: https://github.com/geigerzaehler/beets-check
.. _beets-copyartifacts: https://github.com/adammillerio/beets-copyartifacts
.. _dsedivec: https://github.com/dsedivec/beets-plugins
Expand Down Expand Up @@ -572,3 +579,5 @@ Here are a few of the plugins written by the beets community:
.. _beets-audible: https://github.com/Neurrone/beets-audible
.. _beets-more: https://forgejo.sny.sh/sun/beetsplug/src/branch/main/more
.. _beets-mpd-utils: https://github.com/thekakkun/beets-mpd-utils
.. _beets-webm3u: https://github.com/mgoltzsche/beets-webm3u
.. _beets-webrouter: https://github.com/mgoltzsche/beets-webrouter
3 changes: 2 additions & 1 deletion docs/plugins/smartplaylist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,10 @@ other configuration options are:
- **output**: Specify the playlist format: m3u|extm3u. Default ``m3u``.
- **fields**: Specify the names of the additional item fields to export into
the playlist. This allows using e.g. the ``id`` field within other tools such
as the `webm3u`_ plugin.
as the `webm3u`_ and `Beetstream`_ plugins.
To use this option, you must set the ``output`` option to ``extm3u``.

.. _Beetstream: https://github.com/BinaryBrain/Beetstream
.. _webm3u: https://github.com/mgoltzsche/beets-webm3u

For many configuration options, there is a corresponding CLI option, e.g.
Expand Down

0 comments on commit 3c6309f

Please sign in to comment.