mirror of
https://github.com/beetbox/beets.git
synced 2025-12-15 21:14:19 +01:00
Added documentation for kodiupdate
This commit is contained in:
parent
659c17f825
commit
877d4af344
1 changed files with 44 additions and 0 deletions
44
docs/plugins/kodiupdate.rst
Normal file
44
docs/plugins/kodiupdate.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
KodiUpdate Plugin
|
||||
=================
|
||||
|
||||
``kodiupdate`` is a very simple plugin for beets that lets you automatically
|
||||
update `Kodi`_'s music library whenever you change your beets library.
|
||||
|
||||
To use ``kodiupdate`` plugin, enable it in your configuration
|
||||
(see :ref:`using-plugins`).
|
||||
Then, you'll probably want to configure the specifics of your Kodi host.
|
||||
You can do that using a ``kodi:`` section in your ``config.yaml``,
|
||||
which looks like this::
|
||||
|
||||
kodi:
|
||||
host: localhost
|
||||
port: 8080
|
||||
user: kodi
|
||||
pwd: kodi
|
||||
|
||||
To use the ``kodiupdate`` plugin you need to install the `requests`_ library with:
|
||||
|
||||
pip install requests
|
||||
|
||||
You'll also need to enable jsonrpc in Kodi in order the use the plugin.
|
||||
(System/Settings/Network/Services > Allow control of Kodi via HTTP)
|
||||
|
||||
With that all in place, you'll see beets send the "update" command to your Kodi
|
||||
host every time you change your beets library.
|
||||
|
||||
.. _Kodi: http://kodi.tv/
|
||||
.. _requests: http://docs.python-requests.org/en/latest/
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
The available options under the ``kodi:`` section are:
|
||||
|
||||
- **host**: The Kodi host name.
|
||||
Default: ``localhost``
|
||||
- **port**: The Kodi host port.
|
||||
Default: 8080
|
||||
- **user**: The Kodi host user.
|
||||
Default: ``kodi``
|
||||
- **pwd**: The Kodi host password.
|
||||
Default: ``kodi``
|
||||
Loading…
Reference in a new issue