LGUG2Z/komorebi
GitHub: LGUG2Z/komorebi
一款运行于 Windows 10+ 的平铺窗口管理器，通过 CLI 和键盘快捷键实现自动化的窗口布局与多工作空间管理。
Stars: 14168 | Forks: 312
# komorebi
Windows 的平铺窗口管理。
```
请注意，您不必包含命名管道的完整路径，只需包含名称。
如果命名管道存在，`komorebi` 将开始推送已成功处理的事件和消息的 JSON 数据：
```
{"event":{"type":"AddSubscriber","content":"yasb"},"state":{}}
{"event":{"type":"FocusWindow","content":"Left"},"state":{}}
{"event":{"type":"FocusChange","content":["SystemForeground",{"hwnd":131444,"title":"komorebi – README.md","exe":"idea64.exe","class":"SunAwtFrame","rect":{"left":13,"top":60,"right":1520,"bottom":1655}}]},"state":{}}
{"event":{"type":"MonitorPoll","content":["ObjectCreate",{"hwnd":5572450,"title":"OLEChannelWnd","exe":"explorer.exe","class":"OleMainThreadWndClass","rect":{"left":0,"top":0,"right":0,"bottom":0}}]},"state":{}}
{"event":{"type":"FocusWindow","content":"Right"},"state":{}}
{"event":{"type":"FocusChange","content":["SystemForeground",{"hwnd":132968,"title":"Windows PowerShell","exe":"WindowsTerminal.exe","class":"CASCADIA_HOSTING_WINDOW_CLASS","rect":{"left":1539,"top":60,"right":1520,"bottom":821}}]},"state":{}}
{"event":{"type":"FocusWindow","content":"Down"},"state":{}}
{"event":{"type":"FocusChange","content":["SystemForeground",{"hwnd":329264,"title":"den — Mozilla Firefox","exe":"firefox.exe","class":"MozillaWindowClass","rect":{"left":1539,"top":894,"right":1520,"bottom":821}}]},"state":{}}
{"event":{"type":"FocusWindow","content":"Up"},"state":{}}
{"event":{"type":"FocusChange","content":["SystemForeground",{"hwnd":132968,"title":"Windows PowerShell","exe":"WindowsTerminal.exe","class":"CASCADIA_HOSTING_WINDOW_CLASS","rect":{"left":1539,"top":60,"right":1520,"bottom":821}}]},"state":{}}
```
然后，您可以过滤 `type` 键以侦听您感兴趣的事件。有关可能的通知类型的完整列表，请参阅 `komorebi` 中的 `WindowManagerEvent` 和 `komorebi::core` 中的 `SocketMessage` 的枚举变体。
以下是如何在 `nodejs` 中使用命名管道订阅和过滤事件的示例。
```
const { exec } = require("child_process");
const net = require("net");
const pipeName = "\\\\.\\pipe\\komorebi-js";
const server = net.createServer((stream) => {
console.log("Client connected");
// Every time there is a workspace-related event, let's log the names of all
// workspaces on the currently focused monitor, and then log the name of the
// currently focused workspace on that monitor
stream.on("data", (data) => {
let json = JSON.parse(data.toString());
let event = json.event;
if (event.type.includes("Workspace")) {
let monitors = json.state.monitors;
let current_monitor = monitors.elements[monitors.focused];
let workspaces = monitors.elements[monitors.focused].workspaces;
let current_workspace = workspaces.elements[workspaces.focused];
console.log(
workspaces.elements
.map((workspace) => workspace.name)
.filter((name) => name !== null)
);
console.log(current_workspace.name);
}
});
stream.on("end", () => {
console.log("Client disconnected");
});
});
server.listen(pipeName, () => {
console.log("Named pipe server listening");
});
const command = "komorebic subscribe-pipe komorebi-js";
exec(command, (error, stdout, stderr) => {
if (error) {
console.error(`Error executing command: ${error}`);
return;
}
});
```
## Unix Domain Sockets
可以使用 [Unix Domain Sockets](https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/) 订阅 `komorebi` 处理的每个 `WindowManagerEvent` 和 `SocketMessage` 的通知。
UDS 也是 `komorebi` 和 `komorebic` 之间唯一的通信模式。
首先，您的应用程序必须在 `$ENV:LocalAppData\komorebi` 中创建一个套接字。创建套接字后，运行以下命令：
```
komorebic.exe subscribe-socket
```
如果套接字存在，komorebi 将开始推送已成功处理的事件和消息的 JSON 数据，如上面的命名管道部分中的示例所示。
## Rust 客户端
从 `v0.1.22` 开始，可以使用 `komorebi-client` crate 在 Rust 代码库中订阅 `komorebi` 处理的每个 `WindowManagerEvent` 和 `SocketMessage` 的通知。
以下是如何在基本 Rust 应用程序中使用 `komorebi-client` 的简单示例。
```
// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi" }
use anyhow::Result;
use komorebi_client::Notification;
use komorebi_client::NotificationEvent;
use komorebi_client::UnixListener;
use komorebi_client::WindowManagerEvent;
use std::io::BufRead;
use std::io::BufReader;
use std::io::Read;
pub fn main() -> anyhow::Result<()> {
let socket = komorebi_client::subscribe(NAME)?;
for incoming in socket.incoming() {
match incoming {
Ok(data) => {
let reader = BufReader::new(data.try_clone()?);
for line in reader.lines().flatten() {
let notification: Notification = match serde_json::from_str(&line) {
Ok(notification) => notification,
Err(error) => {
log::debug!("discarding malformed komorebi notification: {error}");
continue;
}
};
// match and filter on desired notifications
}
}
Err(error) => {
log::debug!("{error}");
}
}
}
}
```
一个实际案例可以在 [komokana](https://github.com/LGUG2Z/komokana/blob/feature/komorebi-uds/src/main.rs) 中找到。
## 订阅事件通知模式
可以使用 `komorebic notification-schema` 命令生成发送给订阅者的事件通知的 [JSON Schema](https://json-schema.org/)。此命令的输出可以重定向到剪贴板或文件，可与 [Quicktype](https://app.quicktype.io/) 等服务一起使用，以生成不同编程语言的类型定义。
## 通过 TCP 通信
可以选择使用 `--tcp-port=N` 志在您选择的端口上公开 TCP 监听器。如果未向 `komorebi` 或 `komorebic start` 提供此标志，则不会创建任何 TCP 监听器。
创建后，您的客户端可以像 `komorebic` 那样向 `komorebi` 发送任何 [SocketMessage](https://github.com/LGUG2Z/komorebi/blob/master/komorebi/src/core/mod.rs#L37)。
如果您想创建自己的 `komorebic` 替代品，其中包含脚本和各种中间件层，或者如果您想将 `komorebi` 与[自定义输入处理程序](https://github.com/LGUG2Z/komorebi/issues/176#issue-1302643961)集成，则可以使用此功能。
如果客户端发送无法识别的消息，它将被断开连接，并且必须在尝试再次通信之前重新连接。
## Socket 消息模式
可以使用 `komorebic socket-schema` 命令生成用于向 `komorebi` 发送指令的 socket 消息的 [JSON Schema](https://json-schema.org/)。此命令的输出可以重定向到剪贴板或文件，可与 [Quicktype](https://app.quicktype.io/) 等服务一起使用，以生成不同编程语言的类型定义。
# 致谢
- 首先，感谢我的妻子，既为这个项目命名，也感谢她在其永无止境的开发过程中的耐心
- 感谢 [@sitiom](https://github.com/sitiom) [成为模范的开源社区领导者](https://jeezy.substack.com/p/the-open-source-contributions-i-appreciate)
- 感谢在我之前开发的 [nog](https://github.com/TimUntersberger/nog) 开发者，他们的工作教会了我无法报答的一切
- 感谢 [GlazeWM](https://github.com/lars-berger/GlazeWM) 的开发者，与我一起推动 Windows 上平铺窗口管理的边界，并拥有极佳的合作精神
- 感谢 [@Ciantic](https://github.com/Ciantic) 帮助我将[隐藏的虚拟桌面隐藏功能](https://github.com/Ciantic/AltTabAccessor/issues/1)带到 `komorebi`
标签：GUI, Homebrew安装, Rust, Windows桌面增强, WM, 可视化界面, 工作流优化, 平铺式窗口, 效率工具, 桌面布局, 桌面环境, 桌面自动化, 窗口管理器, 端点可见性, 网络流量审计, 通知系统, 键盘操作