Mopidy-Local

Extension for playing music from a local music archive.

This backend handles URIs starting with local:.

Dependencies

None. The extension just needs Mopidy.

Default configuration

[local]
enabled = true
media_dir = $XDG_MUSIC_DIR
playlists_dir = $XDG_DATA_DIR/mopidy/local/playlists
tag_cache_file = $XDG_DATA_DIR/mopidy/local/tag_cache
scan_timeout = 1000
excluded_file_extensions =
  .html
  .jpeg
  .jpg
  .log
  .nfo
  .png
  .txt

Configuration values

local/enabled

If the local extension should be enabled or not.

local/media_dir

Path to directory with local media files.

local/playlists_dir

Path to playlists directory with m3u files for local media.

local/tag_cache_file

Path to tag cache for local media.

local/scan_timeout

Number of milliseconds before giving up scanning a file and moving on to the next file.

local/excluded_file_extensions

File extensions to exclude when scanning the media directory.

Usage

If you want use Mopidy to play music you have locally at your machine, you need to review and maybe change some of the local extension config values. See above for a complete list. Then you need to generate a tag cache for your local music...

Generating a tag cache

The command mopidy local scan will scan the path set in the local/media_dir config value for any media files and build a MPD compatible tag_cache.

To make a tag_cache of your local music available for Mopidy:

  1. Ensure that the local/media_dir config value points to where your music is located. Check the current setting by running:

    mopidy config
  2. Scan your media library. The command writes the tag_cache to the local/tag_cache_file:

    mopidy local scan
  3. Start Mopidy, find the music library in a client, and play some local music!

Table Of Contents

Previous topic

Mopidy-HTTP

Next topic

Mopidy-MPD

This Page