From 16d44d5e368807b233f342fea1ebcf4e9f87487a Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 31 Oct 2010 02:00:49 +0200 Subject: [PATCH] Update changelog and docs wrt. mopidy-scan --- docs/changes.rst | 2 ++ docs/settings.rst | 42 +++++++++++++++++++++++++++++++++++------- 2 files changed, 37 insertions(+), 7 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index aef0055c..c3df7d85 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -14,6 +14,8 @@ No description yet. - Install ``mopidy.desktop`` file that makes Mopidy available from e.g. Gnome application menus. +- Add :command:`mopidy-scan` command to generate ``tag_cache`` files without + any help from the original MPD server. 0.2.0 (2010-10-24) diff --git a/docs/settings.rst b/docs/settings.rst index 8082b1bb..a7638b4e 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -31,16 +31,44 @@ file:: BACKENDS = (u'mopidy.backends.local.LocalBackend',) -Previously this backend relied purely on ``tag_cache`` files from MPD, to -remedy this the command ``mopidy-scan`` has been added. This program will scan -your current ``LOCAL_MUSIC_FOLDER`` and build a MPD compatible ``tag_cache``. -Currently the command outputs the ``tag_cache`` to ``stdout``, this means that -you will need to run ``mopidy-scan > path/to/your/tag_cache`` to actually start -using your new cache. - You may also want to change some of the ``LOCAL_*`` settings. See :mod:`mopidy.settings`, for a full list of available settings. +.. note:: + + Currently, Mopidy supports using Spotify *or* local storage as a music + source. We're working on using both sources simultaneously, and will + hopefully have support for this in the 0.3 release. + + +Generating a tag cache +---------------------- + +Previously the local storage backend relied purely on ``tag_cache`` files +generated by the original MPD server. To remedy this the command +:command:`mopidy-scan` has been created. The program will scan your current +:attr:`mopidy.settings.LOCAL_MUSIC_FOLDER` and build a MPD compatible +``tag_cache``. + +To make a ``tag_cache`` of your local music available for Mopidy: + +#. Ensure that :attr:`mopidy.settings.LOCAL_MUSIC_FOLDER` points to where your + music is located. Check the current setting by running:: + + mopidy --list-settings + +#. Scan your music library. Currently the command outputs the ``tag_cache`` to + ``stdout``, which means that you will need to redirect the output to a file + yourself:: + + mopidy-scan > tag_cache + +#. Move the ``tag_cache`` file to the location + :attr:`mopidy.settings.LOCAL_TAG_CACHE` is set to, or change the setting to + point to where your ``tag_cache`` file is. + +#. Start Mopidy, find the music library in a client, and play some local music! + Connecting from other machines on the network =============================================