Files
komorebi/docs/usage/subscribing-to-notifications.md
T
LGUG2Z 40eec2f6be feat(wm): follow a window moved to another output
A window can be moved to another output by something other than komorebi: a KWin
shortcut that sends it to the next screen, the window menu, an application.
komorebi had it in a container of the old monitor, whose tile is on a screen the
window is not on, so it sat untiled where it landed.

The bridge now reports a window's output changing, with the frame the window has
by then, since the signal and the frame arrive in no fixed order, and the table
makes it an OutputChange event. The window manager handles it with
WindowManager::follow_windows_to_their_monitors: every container whose focused
window, and every floating window, is on another monitor than the one it has it
on moves whole to the workspace of the same number on the monitor that holds the
middle of its frame, and the monitors that changed are tiled. Every window is
looked at, not only the one in the event, and a move komorebi made itself is in
its state already and finds nothing to do.

Nothing is followed while the user drags a window: the end of the drag decides
where that window goes, so the method returns at once while a move or a resize
by the user is going on.

KWin also moves windows for a moment after outputs come and go, so the monitor
reconciliator looks again 1.5 seconds after each notification, where it used to
trust what it found at once. vm-hotplug sends windows over with kdotool as well
as with komorebic.
2026-10-28 07:20:57 -07:00

4.3 KiB

Subscribing to notifications

A program such as a status bar, a widget or a script can follow what komorebi does by subscribing to its notifications. After each event the window manager handles (a window was shown, closed, focused, minimized, restored or moved to another output), each message it takes on its socket and each change of the monitors, the daemon sends every subscriber a notification: the event, the message or the change, and the state of the window manager after it.

Subscribing

A subscriber listens on a Unix socket of its own in the daemon's data directory, $XDG_RUNTIME_DIR/komorebi (on NixOS and most systemd distributions, /run/user/<uid>/komorebi), and tells the daemon the name of the socket with komorebic subscribe-socket. The socket has to exist before it subscribes: the daemon sends the notification of the subscription at once, and removes a subscriber it cannot connect to.

With socat, a shell can subscribe and print every notification:

socat -u UNIX-LISTEN:"$XDG_RUNTIME_DIR/komorebi/bar.sock",fork STDOUT &
komorebic subscribe-socket bar.sock

komorebic unsubscribe-socket bar.sock stops the notifications.

Notifications

The daemon sends each notification on a new connection to the subscriber's socket: it connects, writes one JSON object, and closes the connection. There is no newline after the object. The first notification a subscriber receives is the one of its subscription.

A notification has two fields:

  • event: the event, the message or the change of the monitors. An event is a window event, with the signal it came from and the window, such as {"type":"Show","content":[{"type":"KWin","content":"WindowAdded"},{"id":...}]}. A message is written the way a client writes it on the daemon's socket, such as {"type":"Retile"}. A change of the monitors is the name of the change with its content: {"Resize":0} for a monitor that changed size, with the id of the monitor, or 0 when KWin does not say which, and {"DisplayConnectionChange":0} for a monitor that was unplugged or plugged in. Changing monitors says when each is sent.
  • state: the state of the window manager after it, with the same fields as what komorebic state prints, on one line.

An event about a window that komorebi does not manage, and a message that fails, are not sent.

Only when something changed

A subscriber can ask to be sent a notification only when the event or the message changed the state, with the filter_state_changes option. It is still sent the notification of a window that is shown, of every change of the monitors, of every new subscription, so it receives the state as soon as it subscribes, of a theme, which changes the colors of the borders and nothing in the state, and of every reload of komorebi.json. komorebic subscribe-socket has no option for it; a program writes the message on the daemon's socket itself:

printf '%s' '{"type":"AddSubscriberSocketWithOptions","content":["bar.sock",{"filter_state_changes":true}]}' |
  socat - UNIX-CONNECT:"$XDG_RUNTIME_DIR/komorebi/komorebi.sock"

When a subscriber goes away

A subscriber that the daemon cannot connect to, because its program has exited or its socket was removed, is removed at the next notification, and its socket file with it. The daemon does not try it again: a program that wants notifications again subscribes again. The daemon keeps its subscribers only while it runs, so after a restart every program has to subscribe again.

When the daemon stops, it connects to each subscriber and closes the connection without writing anything.

A subscriber should accept and read every connection as it comes. The daemon writes each notification while the window manager is locked, and waits when the socket's buffer is full, so a subscriber that stops reading can hold up the window manager. While it is held up, the window events KWin reports wait for it, and once 20 are waiting the daemon drops the ones that come after them.

In Rust

The komorebi-client crate has subscribe and subscribe_with_options, which listen on the socket, subscribe, and return the listener: each connection on it is one Notification. cargo doc --package komorebi-client --open shows their documentation, with an example.