config file ~/.kmpc/config.ini
¶
This file contains several sections, and must be customized for your use. It
will be created with default values the first time kmpc
or kmpcmanager
are run, or you may pass the -n/–newconfig flag to either program to create
the config file only. Several fields are used by only one or the other, and
are described as such below.
[mpd] section¶
kmpc-only¶
- mpdhost
- Hostname or IP address that mpd is running on.
- mpdport
- Port that mpd is running on.
[paths] section¶
kmpc-only¶
- musicpath
- Path to the folder containing music. This should be the same file tree that the mpd server connected above uses. kmpc uses direct file access to pull things like album art and extra id3 tags from the files.
- fanartpath
- Path to the folder containing fanart. The directory structure for this folder is explained in another section.
- tmppath
- Where temporary files should be written.
[sync] section¶
- synchost
- Hostname or IP address of a host to sync with. This is useful if you have a
main mpd server running at home and want to sync songs/ratings/fanart to your
car. The
kmpcmanager
program is used to manage this synchost.kmpc
uses this as a host to ssh to for syncing.kmpcmanager
uses this as the mpd host to connect to. - syncplaylist
- The playlist that
kmpc
will use to sync music files. This should be a playlist on the synchost generated bykmpcmanager
.
kmpc-only¶
- syncmusicpath
- The path to the music folder on the synchost.
- syncfanartpath
- The path to the fanart folder on the synchost.
- synctmppath
- Where temporary files should be written on the synchost.
kmpcmanager-only¶
- syncmpdport
- Port that mpd is running on on the synchost.
- synclocalmusicpath
- The path to the music folder on whatever machine
kmpcmanager
is running on. - synclocalfanartpath
- The path to the fanart folder on whatever machine
kmpcmanager
is running on.
[system] section¶
kmpc-only¶
- rpienable
- Set this to
true
if you are running this on a Pi and want to control Pi-specific features, such as the backlight. Set tofalse
otherwise. Defaults tofalse
. - originalyear
- Set this to
true
to display an mp3’s originalyear tag as well as the regular year tag. Defaults totrue
. - advancedtitles
- Whether to attempt to parse track and album titles to display them more
appropriately on the screen. Defaults to
false
. - exportfirst
- Whether to export ratings before importing them when running Sync All.
Defaults to
true
. - updatecommand
- This is what runs when you press the Update button. Defaults to
sudo pip install -U kmpc --no-deps
. - rebootcommand
- This is what runs when you press the Reboot button. Defaults to
sudo reboot
. - poweroffcommand
- This is what runs when you press the Poweroff button. Defaults to
sudo poweroff
.
[logs] section¶
kmpcmanager-only¶
- artlog
- Whether to generate a file named
artlog.txt
in the config dir that contains data about every media file successfully downloaded from fanart.tv. Defaults tofalse
.
[fanart] section¶
kmpcmanager-only¶
- client_key
- Your personal client key for fanart.tv. This is not necessary, but helps them out if you use it.
[songratings] section¶
Customize the meaning of 0-10 stars. The defaults are probably good enough, but feel free to change them to whatever you want. These are the strings that are shown in the rating popup.
[colors] section¶
- backdrop
- The main backdrop used on all panels.
- button
- All buttons used in the app.
- listitem
- Rows in the playlist or library.
- listitemselected
- A selected row in the playlist or library.
- listitemcurrent
- The current song in the playlist.
[artblacklist] section¶
kmpcmanager-only¶
This section is empty by default. It allows you to blacklist certain fanart files from certain artistids in case you don’t want them automatically downloaded. An entry would look like this:
b38225b8-8e5f-42aa-bcdc-7bae5b5bdab3 = 128387,128388
The key is a MusicBrainz artistid, and the value is a comma-separated list of FanArt.tv image ids to ignore.