]> kaliko git repositories - mpd-sima.git/blob - doc/examples/all_settings.cfg
3be857d42edf4101616c840a27c067a4c550ea12
[mpd-sima.git] / doc / examples / all_settings.cfg
1 ########################################################################
2 #
3 # If you need special settings, rename this file as sima.cfg within
4 # your $XDG_CONFIG_HOME (default is $HOME/.config/sima/)
5 # You can also call it with --config option.
6 #
7 ########################################################################
8
9 ########################## MPD SECTION ################################
10 #
11 [MPD]
12 ## HOST
13 # type: string (IP or FQDN)
14 # description: MPD host
15 # default: localhost
16 host = localhost
17
18 ## PORT
19 # type: integer
20 # description: MPD host port
21 # default: 6600
22 port = 6600
23
24 ## PASSWORD
25 # type: string
26 # default: unset, not using authentication
27 # description: MPD host password, comment if you don't use
28 #password = s3cr3t
29
30 #
31 #######################################################################
32
33 ######################## LOGGING FACILITY #############################
34 #
35 [log]
36 ## LOGFILE
37 # type: string (file path)
38 # description: file to log to. Usually used in daemon mode.
39 # default: unset, logging to stdin/stdout
40 #logfile =
41
42 ## VERBOSITY
43 # type: string
44 # description: log verbosity
45 # default: info
46 # Possible values:
47 #    * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
48 #    * info, default
49 #    * warning
50 #    * error
51 verbosity = info
52
53 #
54 #######################################################################
55
56
57 ######################## SIMA CORE ####################################
58 #
59 # These settings deal with MPD_sima core behaviour.
60 [sima]
61 ## PLUGINS
62 # type: comma separated string list
63 #       for ex.:
64 #                contrib = Scrobble, AwesomePlugin,
65 #                          ExperimentalTest, AnotherTest
66 # default:
67 #          internal = "Crop, Lastfm, RandomFallBack"
68 #          contrib =
69 # description: Plugins list declaration.
70 #     Optional plugin's configuration lays in its own section.
71 #     For instance a "AwesomePlugin" declared here
72 #     gets its configuration from the corresponding section:
73 #     "[awesomeplugin]"
74 #     internal plugins will look for a section named after the lower-cased name
75 #     of the pluglin, ie. RandomFallBack → randomfallback.
76 #
77 #     Two plugins sources are available, internal and contrib
78 #
79 internal = Crop, Lastfm, RandomFallBack
80 #contrib =
81
82 ## HISTORY_DURATION
83 # type: integer (in hours)
84 # default: 8
85 # description: How far to look back in history to avoid to play twice the same
86 #     track/title
87 #
88 history_duration = 8
89
90 ## USER_DB # NOT IMPLEMENTED #
91 # type: boolean
92 # description: Load user database to find similar artists
93 #     User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
94 #     Use simadb_cli to edit/add entries.
95 user_db = false
96
97 ## QUEUE_LENGTH
98 # type: integer
99 # default: 1
100 # description: Queue length triggering tracks addition
101 queue_length = 1
102
103 ######################### PLUGINS #####################################
104
105 [crop]
106 ## CONSUME
107 # type: integer
108 # default: unset, not cropping playlist
109 # description: How many played tracks to keep in the playlist.
110 #  Allow to maintain a fixed length playlist.
111 #  Leave commented to keep all tracks
112 #consume = 10
113
114 [randomfallback]
115 ## FLAVOUR
116 # type: string
117 # default: sensible
118 # description: When no similar tracks are found, falling back to random
119 #     queuing. Different mode, aka random flavour, are available.
120 #     random flavour :
121 #       * pure:     complete random choice among all tracks available in the
122 #                   player media library
123 #       * sensible: use play history to filter chosen tracks
124 #       * genre:    # NOT IMPLEMENTED #
125 #                   chose among the same genre as current track (using genre
126 #                   tag). If no genre tag is available "sensible" flavour
127 #                   is used  instead
128 #flavour=sensible
129
130 ## TRACK_TO_ADD
131 # type: integer
132 # description: how many tracks the plugin will try to get
133 # default: 1
134 #track_to_add = 1
135
136
137 # EchoNest or LastFM
138 #[echonest]
139 [lastfm]
140 ## QUEUE_MODE
141 # type: string
142 # description: The default is to queue random tracks from similar artists.
143 # Possible values:
144 #       track : Will queue tracks from similar artists (default).
145 #       top   : Will queue top tracks from similar artists.
146 #       album : Will queue whole album from similar artists.
147 queue_mode = track
148
149 ## MAX_ART
150 # type: integer
151 # description: Number of similar artist to retrieve from local media library.
152 #  When set to something superior to zero, MPD_sima tries to get as much similar
153 #  artists from media library
154 max_art = 10
155
156 ## DEPTH
157 # type: integer in [1, +∞]
158 # default: 1
159 # description: TBD
160 depth = 1
161
162 ## SINGLE_ALBUM
163 # type: boolean
164 # scope: "track" and "top" queue modes
165 # description: Prevent from queueing a track from the same album (for instance
166 #  with OST).
167 single_album = false
168
169 ## TRACK_TO_ADD
170 # type: integer
171 # scope: "track" and "top" queue modes
172 # description: how many tracks the plugin will try to get
173 track_to_add = 1
174
175 ## ALBUM_TO_ADD
176 # type: integer
177 # scope: "album" queue mode
178 # description: how many albums the plugin will try to get
179 album_to_add = 1
180
181 ## CACHE
182 # type: boolean
183 # description: whether or not to use on-disk persistent http cache
184 #  * When set to "true", sima will use a persistent cache for its http client.
185 #    The cache is written along with the dbfile in:
186 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
187 #    Toggling http cache is only available for last.fm. EchoNest have rate limits,
188 #    we must then pay attention to bandwidth and use of caching is required.
189 #  * If set to "false", caching is still done but in memory.
190 # default: True
191 cache = True
192
193 #
194 ####################### END OF CONFIGURATION ##########################
195 # vim: syntax=cfg fileencoding=utf-8