doc/source/user/01_configurations.rst

   1 Configuration examples
   2 ======================
   3
   4 Configuration location is ``${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg`` usually ``${XDG_CONFIG_HOME}``  is in ``${HOME}/.config/``.
   5
   6
   7 Default configuration
   8 ---------------------
   9
  10 MPD_sima runs without explicit configuration as long as your MPD server is easy
  11 to discover (``localhost:6600`` or exposed via environment variables ``MPD_HOST``/``MPD_PORT``).
  12
  13 The default configuration is to run in *track mode* with suggestions from last.fm:
  14
  15 .. code:: ini
  16
  17     [MPD]
  18     # Change MPD server here
  19     #host = mpdserver.example.org
  20     #port = 6600
  21
  22     [sima]
  23     internal = Crop, Lastfm, Random
  24     history_duration = 8
  25     queue_length = 2
  26
  27     [crop]
  28     consume = 10
  29
  30     [lastfm]
  31     queue_mode = track
  32     single_album = False
  33     track_to_add = 1
  34
  35 Album mode
  36 ^^^^^^^^^^
  37
  38 One of the first request added to MPD_sima was album mode. It allows to queue whole album instead of single tracks.
  39
  40 Here the configuration keeps the queue plugin *Lastfm* but configure it to queue albums (``queue_mode = album``) and ask for 2 albums to be add.
  41
  42 The configuration of MPD_sima in ``sima`` section is also modified for ``queue_length``. The value of 10 is to trigger album queueing when there are 10 tracks or less in the queue.
  43
  44 .. code:: ini
  45
  46     [MPD]
  47     # Change MPD server here
  48     #host = mpdserver.example.org
  49     #port = 6600
  50
  51     [sima]
  52     internal = Crop, Lastfm, Random
  53     history_duration = 8
  54     queue_length = 10
  55
  56     [crop]
  57     consume = 10
  58
  59     [lastfm]
  60     queue_mode = album
  61     album_to_add = 2
  62
  63
  64 Offline auto-queuing
  65 --------------------
  66
  67
  68 .. vim: spell spelllang=en