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 interval:
25 typeof: integer
26 default: 5
27 The interval in which the connection to the MPD server is retried
28 timeout:
30 typeof: integer
31 default: 30
32 The timeout for the connection. Change this if your MPD server has
33 a low `connection_timeout` setting
34 unknown-tag:
36 typeof: string
37 default: "N/A"
38 The text to display when a tag is not present in the current song,
39 but used in `format`
40 format:
42 typeof: string
43 default: "{album} - {artist} - {title}"
44 Information displayed when a song is playing.
45 format-stopped:
47 typeof: string
48 default: "stopped"
49 Information displayed when the player is stopped.
50 format-paused:
52 typeof: string
53 This format is used when a song is paused.
54 format-disconnected:
56 typeof: string
57 default: "disconnected"
58 Information displayed when the MPD server can't be reached.
59 tooltip:
61 typeof: bool
62 default: true
63 Option to disable tooltip on hover.
64 tooltip-format:
66 typeof: string
67 default: "MPD (connected)"
68 Tooltip information displayed when connected to MPD.
69 tooltip-format-disconnected:
71 typeof: string
72 default: "MPD (disconnected)"
73 Tooltip information displayed when the MPD server can't be
74 reached.
75 rotate:
77 typeof: integer
78 Positive value to rotate the text label.
79 max-length:
81 typeof: integer
82 The maximum length in character the module should display.
83 on-click:
85 typeof: string
86 Command to execute when clicked on the module.
87 on-click-middle:
89 typeof: string
90 Command to execute when middle-clicked on the module using mouse‐
91 wheel.
92 on-click-right:
94 typeof: string
95 Command to execute when you right clicked on the module.
96 on-scroll-up:
98 typeof: string
99 Command to execute when scrolling up on the module.
100 on-scroll-down:
102 typeof: string
103 Command to execute when scrolling down on the module.
104 smooth-scrolling-threshold:
106 typeof: double
107 Threshold to be used when scrolling.
108 state-icons:
110 typeof: object
111 default: {}
112 Icon to show depending on the play/pause state of the player ({
113 "playing": "...", "paused": "..." })
114 consume-icons:
116 typeof: object
117 default: {}
118 Icon to show depending on the "consume" option ({ "on": "...",
119 "off": "..." })
120 random-icons:
122 typeof: object
123 default: {}
124 Icon to show depending on the "random" option ({ "on": "...",
125 "off": "..." })
126 repeat-icons:
128 typeof: object
129 default: {}
130 Icon to show depending on the "repeat" option ({ "on": "...",
131 "off": "..." })
132 single-icons:
134 typeof: object
135 default: {}
136 Icon to show depending on the "single" option ({ "on": "...",
137 "off": "..." })
138
140 WHEN PLAYING/PAUSED
141 {artist}: The artist of the current song
142 {albumArtist}: The artist of the current album
144 {album}: The album of the current song
146 {title}: The title of the current song
148 {date}: The date of the current song
150 {elapsedTime}: The current position of the current song. To format as a
152 date/time (see example configuration)
153 {totalTime}: The length of the current song. To format as a date/time
155 (see example configuration)
156 {stateIcon}: The icon corresponding the playing or paused status of the
158 player (see state-icons option)
159 {consumeIcon}: The icon corresponding the "consume" option (see con‐
161 sume-icons option)
162 {randomIcon}: The icon corresponding the "random" option (see random-
164 icons option)
165 {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
167 icons option)
168 {singleIcon}: The icon corresponding the "single" option (see single-
170 icons option)
171 WHEN STOPPED
173 {consumeIcon}: The icon corresponding the "consume" option (see con‐
174 sume-icons option)
175 {randomIcon}: The icon corresponding the "random" option (see random-
177 icons option)
178 {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
180 icons option)
181 {singleIcon}: The icon corresponding the "single" option (see single-
183 icons option)
184 WHEN DISCONNECTED
186 Currently, no format replacements when disconnected.
187
189 "mpd": {
190 "format": "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ",
191 "format-disconnected": "Disconnected ",
192 "format-stopped": "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ",
193 "interval": 2,
194 "consume-icons": {
195 "on": " " // Icon shows only when "consume" is on
196 },
197 "random-icons": {
198 "off": "<span color="#f53c3c"></span> ", // Icon grayed out when "random" is off
199 "on": " "
200 },
201 "repeat-icons": {
202 "on": " "
203 },
204 "single-icons": {
205 "on": "1 "
206 },
207 "state-icons": {
208 "paused": "",
209 "playing": ""
210 },
211 "tooltip-format": "MPD (connected)",
212 "tooltip-format-disconnected": "MPD (disconnected)"
213 }
214
216 · #mpd
217 · #mpd.disconnected
218 · #mpd.stopped
219 · #mpd.playing
220 · #mpd.paused
221 2020-04-11 waybar-mpd(5)