/plugin.audio.beets

A Kodi plugin for streaming audio from a beets web server.

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

plugin.audio.beets

Such a nifty logo.

A Kodi add-on for streaming music from a Beets library using the Beets web plugin.

##Installation

The easiest way to install this add-on at the moment is to git clone this repository into your add-on directory of your Kodi installation.

Like so:

$ git clone https://github.com/HugoMillwood/plugin.audio.beets.git <addon directory>/plugin.audio.beets

For example:

$ git clone https://github.com/HugoMillwood/plugin.audio.beets.git /usr/share/kodi/addons/plugin.audio.beets

Or you can just cd into your add-on directory and run:

$ git clone https://github.com/HugoMillwood/plugin.audio.beets.git

The add-on directory is located in different places depending on your platform.

OS Path
Linux /usr/share/kodi/addons
OS X /Applications/Kodi.app/Contents/Resources/Kodi/addons
Windows %PROGRAMFILES(x86)%\XBMC\addons
OpenELEC /storage/.kodi/addons

To update the add-on you just have to git pull in the cloned directory.

Like so:

$ git -C <addon directory>/plugin.audio.beets pull

Or you can just cd into your cloned directory and run:

$ git pull

##Configuration

There are two necessary settings for the add-on to function properly:

Setting Description
IP Address The IP address of the host running Beets and the web plugin.
Port The port of the Beets web plugin server.

Note that you only have to change the port if you're not using the default 8337 port.

Make sure you are using the web plugin on your server running Beets. If you want album art to be displayed in Kodi you must also use the fetchart plugin.

The web plugin for Beets needs to be running on the server you want to stream from.

On your server:

$ beet web &

This creates a web server session detached from your shell. Skip the & if you want the session attached.

Configure the add-on using the Kodi user interface:

System ➜ Settings ➜ Add-ons ➜ Enabled Add-ons ➜ Music Add-ons ➜ Beets ➜ Configure

###Important!

We haven't been able to get things working with PAPlayer (the default audio player in Kodi) with streaming FLAC. This plugin uses the DVDPlayer which does not have the curl buffer issues that we have been experiencing.

Note that the directories listed in this README are bound to change. Check yourself before you wreck yourself.

Authors

Hugo Millwood and Pär Strindevall.

License

plugin.audio.beets is distributed under the Simplified BSD license. See LICENSE.