1waybar-mpd(5) File Formats Manual waybar-mpd(5)
2
6 waybar - mpd module
7
9 The mpd module displays information about a running "Music Player Dae‐
10 mon" instance.
11
13 Addressed by mpd
14 server:
16 typeof: string
17 The network address or Unix socket path of the MPD server. If
18 empty, connect to the default host.
19 port:
21 typeof: integer
22 The port MPD listens to. If empty, use the default port.
23 password:
25 typeof: string
26 The password required to connect to the MPD server. If empty, no
27 password is sent to MPD.
28 interval:
30 typeof: integer
31 default: 5
32 The interval in which the connection to the MPD server is retried
33 timeout:
35 typeof: integer
36 default: 30
37 The timeout for the connection. Change this if your MPD server has
38 a low `connection_timeout` setting
39 unknown-tag:
41 typeof: string
42 default: "N/A"
43 The text to display when a tag is not present in the current song,
44 but used in `format`
45 format:
47 typeof: string
48 default: "{album} - {artist} - {title}"
49 Information displayed when a song is playing.
50 format-stopped:
52 typeof: string
53 default: "stopped"
54 Information displayed when the player is stopped.
55 format-paused:
57 typeof: string
58 This format is used when a song is paused.
59 format-disconnected:
61 typeof: string
62 default: "disconnected"
63 Information displayed when the MPD server can't be reached.
64 tooltip:
66 typeof: bool
67 default: true
68 Option to disable tooltip on hover.
69 tooltip-format:
71 typeof: string
72 default: "MPD (connected)"
73 Tooltip information displayed when connected to MPD.
74 tooltip-format-disconnected:
76 typeof: string
77 default: "MPD (disconnected)"
78 Tooltip information displayed when the MPD server can't be
79 reached.
80 artist-len:
82 typeof: integer
83 Maximum length of the Artist tag.
84 album-len:
86 typeof: integer
87 Maximum length of the Album tag.
88 album-artist-len:
90 typeof: integer
91 Maximum length of the Album Artist tag.
92 title-len:
94 typeof: integer
95 Maximum length of the Title tag.
96 rotate:
98 typeof: integer
99 Positive value to rotate the text label.
100 max-length:
102 typeof: integer
103 The maximum length in character the module should display.
104 min-length:
106 typeof: integer
107 The minimum length in characters the module should take up.
108 align:
110 typeof: float
111 The alignment of the text, where 0 is left-aligned and 1 is right-
112 aligned. If the module is rotated, it will follow the flow of the text.
113 on-click:
115 typeof: string
116 Command to execute when clicked on the module.
117 on-click-middle:
119 typeof: string
120 Command to execute when middle-clicked on the module using mouse‐
121 wheel.
122 on-click-right:
124 typeof: string
125 Command to execute when you right clicked on the module.
126 on-update:
128 typeof: string
129 Command to execute when the module is updated.
130 on-scroll-up:
132 typeof: string
133 Command to execute when scrolling up on the module.
134 on-scroll-down:
136 typeof: string
137 Command to execute when scrolling down on the module.
138 smooth-scrolling-threshold:
140 typeof: double
141 Threshold to be used when scrolling.
142 state-icons:
144 typeof: object
145 default: {}
146 Icon to show depending on the play/pause state of the player ({
147 "playing": "...", "paused": "..." })
148 consume-icons:
150 typeof: object
151 default: {}
152 Icon to show depending on the "consume" option ({ "on": "...",
153 "off": "..." })
154 random-icons:
156 typeof: object
157 default: {}
158 Icon to show depending on the "random" option ({ "on": "...",
159 "off": "..." })
160 repeat-icons:
162 typeof: object
163 default: {}
164 Icon to show depending on the "repeat" option ({ "on": "...",
165 "off": "..." })
166 single-icons:
168 typeof: object
169 default: {}
170 Icon to show depending on the "single" option ({ "on": "...",
171 "off": "..." })
172
174 WHEN PLAYING/PAUSED
175 {artist}: The artist of the current song
176 {albumArtist}: The artist of the current album
178 {album}: The album of the current song
180 {title}: The title of the current song
182 {date}: The date of the current song
184 {volume}: The current volume in percent
186 {elapsedTime}: The current position of the current song. To format as a
188 date/time (see example configuration)
189 {totalTime}: The length of the current song. To format as a date/time
191 (see example configuration)
192 {songPosition}: The position of the current song.
194 {queueLength}: The length of the current queue.
196 {stateIcon}: The icon corresponding the playing or paused status of the
198 player (see state-icons option)
199 {consumeIcon}: The icon corresponding the "consume" option (see con‐
201 sume-icons option)
202 {randomIcon}: The icon corresponding the "random" option (see random-
204 icons option)
205 {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
207 icons option)
208 {singleIcon}: The icon corresponding the "single" option (see single-
210 icons option)
211 WHEN STOPPED
213 {consumeIcon}: The icon corresponding the "consume" option (see con‐
214 sume-icons option)
215 {randomIcon}: The icon corresponding the "random" option (see random-
217 icons option)
218 {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
220 icons option)
221 {singleIcon}: The icon corresponding the "single" option (see single-
223 icons option)
224 WHEN DISCONNECTED
226 Currently, no format replacements when disconnected.
227
229 "mpd": {
230 "format": "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ",
231 "format-disconnected": "Disconnected ",
232 "format-stopped": "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ",
233 "interval": 2,
234 "consume-icons": {
235 "on": " " // Icon shows only when "consume" is on
236 },
237 "random-icons": {
238 "off": "<span color="#f53c3c"></span> ", // Icon grayed out when "random" is off
239 "on": " "
240 },
241 "repeat-icons": {
242 "on": " "
243 },
244 "single-icons": {
245 "on": "1 "
246 },
247 "state-icons": {
248 "paused": "",
249 "playing": ""
250 },
251 "tooltip-format": "MPD (connected)",
252 "tooltip-format-disconnected": "MPD (disconnected)"
253 }
254
256 • #mpd
257 • #mpd.disconnected
258 • #mpd.stopped
259 • #mpd.playing
260 • #mpd.paused
261 2023-01-11 waybar-mpd(5)