1waybar-mpd(5)                 File Formats Manual                waybar-mpd(5)
2
3
4

NAME

6       waybar - mpd module
7

DESCRIPTION

9       The mpd module displays information about a running "Music Player Dae‐
10       mon" instance.
11

CONFIGURATION

13       Addressed by mpd
14
15       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
20       port:
21            typeof: integer
22            The port MPD listens to. If empty, use the default port.
23
24       password:
25            typeof: string
26            The password required to connect to the MPD server. If empty, no
27       password is sent to MPD.
28
29       interval:
30            typeof: integer
31            default: 5
32            The interval in which the connection to the MPD server is retried
33
34       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
40       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
46       format:
47            typeof: string
48            default: "{album} - {artist} - {title}"
49            Information displayed when a song is playing.
50
51       format-stopped:
52            typeof: string
53            default: "stopped"
54            Information displayed when the player is stopped.
55
56       format-paused:
57            typeof: string
58            This format is used when a song is paused.
59
60       format-disconnected:
61            typeof: string
62            default: "disconnected"
63            Information displayed when the MPD server can't be reached.
64
65       tooltip:
66            typeof: bool
67            default: true
68            Option to disable tooltip on hover.
69
70       tooltip-format:
71            typeof: string
72            default: "MPD (connected)"
73            Tooltip information displayed when connected to MPD.
74
75       tooltip-format-disconnected:
76            typeof: string
77            default: "MPD (disconnected)"
78            Tooltip information displayed when the MPD server can't be
79       reached.
80
81       rotate:
82            typeof: integer
83            Positive value to rotate the text label.
84
85       max-length:
86            typeof: integer
87            The maximum length in character the module should display.
88
89       on-click:
90            typeof: string
91            Command to execute when clicked on the module.
92
93       on-click-middle:
94            typeof: string
95            Command to execute when middle-clicked on the module using mouse‐
96       wheel.
97
98       on-click-right:
99            typeof: string
100            Command to execute when you right clicked on the module.
101
102       on-update:
103            typeof: string
104            Command to execute when the module is updated.
105
106       on-scroll-up:
107            typeof: string
108            Command to execute when scrolling up on the module.
109
110       on-scroll-down:
111            typeof: string
112            Command to execute when scrolling down on the module.
113
114       smooth-scrolling-threshold:
115            typeof: double
116            Threshold to be used when scrolling.
117
118       state-icons:
119            typeof: object
120            default: {}
121            Icon to show depending on the play/pause state of the player ({
122       "playing": "...", "paused": "..." })
123
124       consume-icons:
125            typeof: object
126            default: {}
127            Icon to show depending on the "consume" option ({ "on": "...",
128       "off": "..." })
129
130       random-icons:
131            typeof: object
132            default: {}
133            Icon to show depending on the "random" option ({ "on": "...",
134       "off": "..." })
135
136       repeat-icons:
137            typeof: object
138            default: {}
139            Icon to show depending on the "repeat" option ({ "on": "...",
140       "off": "..." })
141
142       single-icons:
143            typeof: object
144            default: {}
145            Icon to show depending on the "single" option ({ "on": "...",
146       "off": "..." })
147

FORMAT REPLACEMENTS

149   WHEN PLAYING/PAUSED
150       {artist}: The artist of the current song
151
152       {albumArtist}: The artist of the current album
153
154       {album}: The album of the current song
155
156       {title}: The title of the current song
157
158       {date}: The date of the current song
159
160       {elapsedTime}: The current position of the current song. To format as a
161       date/time (see example configuration)
162
163       {totalTime}: The length of the current song. To format as a date/time
164       (see example configuration)
165
166       {songPosition}: The position of the current song.
167
168       {queueLength}: The length of the current queue.
169
170       {stateIcon}: The icon corresponding the playing or paused status of the
171       player (see state-icons option)
172
173       {consumeIcon}: The icon corresponding the "consume" option (see con‐
174       sume-icons option)
175
176       {randomIcon}: The icon corresponding the "random" option (see random-
177       icons option)
178
179       {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
180       icons option)
181
182       {singleIcon}: The icon corresponding the "single" option (see single-
183       icons option)
184
185   WHEN STOPPED
186       {consumeIcon}: The icon corresponding the "consume" option (see con‐
187       sume-icons option)
188
189       {randomIcon}: The icon corresponding the "random" option (see random-
190       icons option)
191
192       {repeatIcon}: The icon corresponding the "repeat" option (see repeat-
193       icons option)
194
195       {singleIcon}: The icon corresponding the "single" option (see single-
196       icons option)
197
198   WHEN DISCONNECTED
199       Currently, no format replacements when disconnected.
200

EXAMPLES

202           "mpd": {
203                "format": "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ",
204                "format-disconnected": "Disconnected ",
205                "format-stopped": "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ",
206                "interval": 2,
207                "consume-icons": {
208                     "on": " " // Icon shows only when "consume" is on
209                },
210                "random-icons": {
211                     "off": "<span color="#f53c3c"></span> ", // Icon grayed out when "random" is off
212                     "on": " "
213                },
214                "repeat-icons": {
215                     "on": " "
216                },
217                "single-icons": {
218                     "on": "1 "
219                },
220                "state-icons": {
221                     "paused": "",
222                     "playing": ""
223                },
224                "tooltip-format": "MPD (connected)",
225                "tooltip-format-disconnected": "MPD (disconnected)"
226           }
227

STYLE

229       ·   #mpd
230       ·   #mpd.disconnected
231       ·   #mpd.stopped
232       ·   #mpd.playing
233       ·   #mpd.paused
234
235
236
237                                  2021-02-10                     waybar-mpd(5)
Impressum