]> kaliko git repositories - mpd-sima.git/blob - doc/examples/all_settings.cfg
77abb7a89a4d8393fd11225bc359f6434e505dca
[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 # Pay Attention:
8 # * Inline comment are not possible
9 #  
10 #  WRONG:
11 #  host = localhost  # My host
12 #
13 #  OK:
14 #  # My host
15 #  host = localhost
16 #
17 ########################################################################
18
19 #
20 #######################################################################
21
22 ########################## MPD SECTION ################################
23 #
24 [MPD]
25 ## HOST
26 # type: string
27 host = localhost
28 ## PORT
29 # type: integer
30 port = 6600
31 ## PASSWORD
32 # type: string
33 #
34 # please comment if you don't use
35 #password = s3cr3t
36
37 #
38 #######################################################################
39
40 ######################## LOGGING FACILITY #############################
41 #
42 [log]
43 # message are logged to console
44 #
45 ## VERBOSITY
46 # type: string
47 #
48 # pick verbosity in : debug, info, warning, error
49 # default if not specify is "info"
50 # *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
51 verbosity = info
52 ##
53 #
54 #######################################################################
55
56 ######################### PLUGINS #####################################
57 #
58 [placeholder]
59 key = Value
60 ##
61 #
62 #######################################################################
63
64
65 ######################## SIMA CORE ####################################
66 #
67 [sima]
68 ## PLUGINS
69 # type: comma separated string list
70 # for ex.:
71 #          plugins = Scrobble, AwesomePlugin,
72 #                    ExperimentalTest,AnotherTest
73 #
74 # Plugins list declaration.
75 # Optional plugin's configuration must be in its own section. For instance an
76 # "AwesomePlugin" declared here gets its configuration from the
77 # "[AwesomePlugin]" or "[awesomeplugin]" section (case insensitive).
78 #
79 plugins = PlaceHolder
80
81 ## HISTORY_DURATION
82 # type: integer (in hours)
83 #
84 # How far to look back in history to avoid to play twice the same track/title
85 #
86 history_duration = 8
87 ##
88
89 ## CONSUME
90 # type: integer
91 #
92 # How many played tracks to keep in the playlist.
93 # Allow to maintain a fixed length playlist.
94 # set to 0 to keep all played tracks.
95 #
96 consume = 0
97 ##
98
99 ## SINGLE_ALBUM
100 # type: boolean
101 # scope: "track" and "top" queue modes
102 #
103 # Prevent from queueing a track from the same album (for instance with OST).
104 single_album = false
105 ##
106
107
108 # These settings deal with MPD_sima core behaviour.
109
110 ## Queue Mode
111 ##
112 # The default is to queue random tracks from similar artists.
113 #
114 ## QUEUE_MODE
115 # type: string
116 #
117 # Possible values:
118 #       track : Will queue tracks from similar artists (default).
119 #       top   : Will queue top tracks from similar artists.
120 #       album : Will queue whole album from similar artists.
121 queue_mode = track
122
123 ## SIMILARITY
124 # type: integer in [0 100]
125 #
126 # Similarity as a percentage of similarity for the artist the code is
127 # looking for.
128 similarity = 15
129 ##
130
131 ## DYNAMIC
132 # type: integer
133 #
134 # Number of similar artist to retrieve from local media library.
135 # When set to something superior to zero, MPD_sima tries to get as much similar
136 # artists from media library provided artists similarity is superior to
137 # similarity value.
138 dynamic = 10
139 ##
140
141 ## USER_DB
142 # type: boolean
143 #
144 # Load user database to find similar artists
145 # User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
146 # Use simadb_cli to edit/add entries.
147 user_db = false
148 ##
149
150 #####################################################################
151 # You do not need to set up options below.
152 # But well, you got bored of the way MPD_sima is behaving, then go ahead
153 # play with it :)
154
155 ## QUEUE_LENGTH
156 # type: integer
157 #
158 # Queue length triggering tracks addition
159 queue_length = 1
160 ##
161
162 ## TRACK_TO_ADD
163 # type: integer
164 # scope: "track" and "top" queue modes
165 #
166 # Missing Description…
167 track_to_add = 1
168 ##
169
170 ## ALBUM_TO_ADD
171 # type: integer
172 # scope: "album" queue mode
173 #
174 # Missing Description…
175 album_to_add = 1
176 ##
177 #
178 ####################### END OF CONFIGURATION ##########################
179
180 # vim: syntax=cfg fileencoding=utf-8