README zh
该指南并非原 README 的逐字翻译, 我做了一些改编使得中文使用者更易于理解, 同时去掉了部分与使用无关的内容.
This guide is not a word by word translation of original README. Adaptations are made to make it more readable for Chinese user, and omit some section like contribution. (I assume one who has ability to contribute can read original English README)
Windows上的平铺式窗口管理器。
komorebi 是一个平铺式窗口管理器，作为对Windows 10及以上系统的默认窗口管理器 的扩展。komorebi 相关的讨论、帮助及常见问题处理参见Discord server。您可以通过issue提交功能需求或错误报告。关于_komorebi_的文章，博客，示例和视频请补充到下面的列表：
komorebi 是又一个 Windows 平铺式窗口管理器, 受 bspwm 所启发.
komorebi 和 Linux 上的 bspwm 以及
macOS 中的 yabai 一样, 按照如下架构实现
PROCESS SOCKET
ahk --------> komorebic <------> komorebi-
komorebi仅响应 WinEvents 和专用 socket 中的消息； -
komorebic是一个向komorebi的专用 socket 中发送消息的命令行程序； -
komorebi本身不支持任何键盘和鼠标操作，需要通过第三方程序（如AutoHotKey）将键盘和鼠标操作转换为komorebic的命令。另，也可直接向专用socket发送消息(如使用Python 的 keyboard 库)。
komorebi 是 yatta 的继任者，基于其优秀经验打造。
当初做 yatta ，主要是学习如何使用Rust以及如何在Rust中调用Windows API，同时实现一个简单的平铺窗口管理器以满足自己的日常使用(主要是单显示器、单工作区)。 komorebi 则从头开始，全新设计，以支持更复杂的，在其它平台上早已是标准的特性（指平铺式窗口管理器）。
komorebi 管理着所有物理监视器 (monitor) ；监视器 (monitor) 可以看做包含一个或多个虚拟工作空间 (workspace) 的区域；工作空间 (workspace) 又包含多个窗口容器 (containers) ；应用程序则显示在这些窗口容器 (container) 中。
也就是说
- 每个物理显示器都可以有它自己的一套虚拟工作空间
- 工作空间仅可以感知其下的窗口容器, 而非窗口容器下的应用程序窗口
- 每个应用程序窗口都必然属于一个窗口容器, 即使该容器仅包含一个应用程序窗口
- 属于同一窗口容器的多个应用程序窗口，可以堆叠 (stacked)和循环
该教程希望读者对以下概念有着基本掌握
如果有不熟悉的概念, 仍然可以往下阅读, 但掌握以上概念可以拥有更好的阅读体验.
你可以在 GitHub Release 找到预编译的二进制包. 当然在下载之后你得手动将 komorebi.exe 和 komorebic.exe 放到你的 PATH 环境变量之中. (你可以在 PowerShell 终端中输入 $Env:Path.split(";") 来查看当前 PATH 环境变量所包含的路径)
你可以用 setx 命令或者在 PowerShell 中输入 SystemPropertiesAdvanced.exe 打开的 系统属性 窗口中点击 环境变量... 来设置添加里面有 komorebic.exe 和 komorebi.exe 的目录. 具体操作请百度/Google, 或参考如何设置或更改 PATH 系统变量？, 这里不再赘述.
如果你使用 Scoop 包管理器的话, 你可以用以下命令来从 GitHub Release 中下载安装 komorebi
scoop bucket add komorebi https://github.com/LGUG2Z/komorebi-bucket
scoop install komorebi如果使用这种方式安装 komorebi, 那么其二进制文件会自行加入到你的 PATH 环境变量中, 并且会提示你使用示例配置文件来开始使用.
如果你更喜欢从源码编译, 你得有 Rust Windows 10 开发环境 还有 x86_64-pc-windows-msvc 工具链, 还得确保你安装了 Build Tools for Visual Studio 2019.
你可以 clone 这个仓库并使用以下命令来编译安装 komorebi 和 komorebic
cargo install --path komorebi --locked
cargo install --path komorebic --lockedrustup 会自动将编译后的文件添加至 PATH 环境变量之中, 无需手动添加环境变量.
一旦你将 komorebi 和 komorebic 添加至 PATH 环境变量之中, 你就可以在 PowerShell 终端运行
komorebic start此时应该会返回
Start-Process komorebi -WindowStyle hidden这意味着 kmoorebi 现在已经在后台正常运行, 管理你的所有窗口, 并监听来自 komorebic 的命令. 你可以用
komorebic stop来停止正在运行的 komorebi 进程.
正如在之前所提到的, 该项目不会直接管理你的键盘绑定, 你需要一个类似 sxhkd 之类的玩意来辅助管理热键. 官方钦定的管理软件是 AutoHotkey, 当然没人拦你选别的.
你可以通过在 PowerShell 直接执行 komorebic 来改变 komorebi 的状态.
下面是可能的命令列表
start 以背景进程运行 komorebi
stop 停止 komorebi 进程并恢复所有窗口
state 显示当前窗口管理器的状态
log 使用 tail 参看 komorebi 的日志
focus 改变焦点 (后接方向)
move 移动窗口 (同一工作空间中)
stack 堆叠窗口
resize 改变当前窗口大小
unstack 撤销堆叠
cycle-stack 循环堆叠中的窗口
move-to-monitor 移动窗口到监视器 (焦点会切换到目标监视器)
move-to-workspace 移动窗口到工作空间 (焦点会切换到目标工作空间)
send-to-monitor 移动窗口到监视器 (焦点保留在当前监视器)
send-to-workspace 移动窗口到工作空间 (焦点保留在当前工作空间)
focus-monitor 切换聚焦监视器
focus-workspace 切换聚焦工作空间
new-workspace 新建工作空间
adjust-container-padding 调整窗口容器间距
adjust-workspace-padding 调整工作空间间距
change-layout 改变工作空间布局
flip-layout 反转工作空间 (仅能在 BSP 布局使用)
promote 将当前聚焦窗口移动至最前
retile 强制工作空间重排
ensure-workspaces 创建指定数量的工作空间
container-padding 指定窗口容器间距
workspace-padding 指定工作空间间距
workspace-layout 指定工作空间布局
workspace-tiling 指定工作空间平铺/浮动
workspace-name 指定工作空间名称
toggle-pause 暂停 komorebi
toggle-tiling 切换当前工作空间平铺/浮动
toggle-float 切换当前窗口平铺/浮动
toggle-monocle 切换单窗口布局
toggle-maximize 切换当前窗口最大化
restore-windows 还原所有窗口
manage 强制捕捉当前窗口
unmanage 还原强制捕捉的窗口
reload-configuration 重新加载 ~/komorebi.ahk
watch-configuration 检测 ~/kmorebi.ahk 内容变化自动加载
float-rule 设立窗口浮动规则
manage-rule 设立强制捕捉规则
workspace-rule 设立窗口与工作空间关联规则
identify-tray-application 设立任务栏程序标识规则
focus-follows-mouse 设置是否焦点跟随鼠标
toggle-focus-follows-mouse 切换焦点跟随鼠标
ahk-library 生成 AHK 辅助函数
help 显示本消息一旦 komorebi 开始运行，你就可以用 AutoHotKey 执行 komorebi.sample.ahk 设置默认的按键绑定（该文件包含了能帮助你构建你自己的配置文件的注释）
你也可以在 这里 找到一份 AutoHotKey v1 的示例配置文件.
如果你已经安装了 AutoHotKey 并且有 komorebi.ahk 在你的 UserProfile 环境变量指向目录（你可以在PowerShell运行 $Env:UserProfile 来查看该目录所在位置），komorebi 会在启动时自动装载它
komorebi 还搭载了暂时的 AutoHotkey v2 支持，如果有 komorebi.ahk2 存在于 UserProfile 环境变量所指向目录之中, 以及 AutoHotkey v2 版本的 AutoHotKey64.exe 存在于 PATH 环境变量. 那么 komorebi 就会尝试在启动时加载它. 你可 以在这里找到一份 AutoHotkey v2 的示例配置文件
如果 komorebi.ahk2 和 komorebi.ahk 两者都存在，只有 komorebi.ahk 的配置文件会被载入，也就是说 AutoHotkey v1 的配置文件的优先级会更高.
有时你不想让一个窗口被平铺，你可以用
komorebic toggle-float来切换当前聚焦的窗口是否被平铺。但是当你想设定规则来使某一类窗口永远不平铺时，你需要 float-rule
komorebic.exe float-rule title "Control Panel"
# komorebic.exe float-rule exe [EXE 可执行文件名]
# komorebic.exe float-rule class [窗口类名]
# komorebic.exe float-rule title [窗口标题]虽然 komorebi 可以捕获大部分窗口，但对于某些国产软件（像是 QQ，TIM或者是微信）它仍然需要用户手动指定规则才能正确捕获
komorebic.exe manage-rule exe TIM.exe
# komorebic.exe manage-rule exe [EXE 可执行文件名]
# komorebic.exe manage-rule class [窗口类名]
# komorebic.exe manage-rule title [窗口标题]如果你在关闭应用程序窗口时出现关闭窗口后仍留下空白的情况, 那么可能是因为该应用程序启用了「关闭时最小化到任务栏」(如各类聊天软件如QQ, Telegram, Discord 或是微信; 音乐软件如网易云, Spotify). komorebi 需要用户手动指定规则来正确地处理这样的应用程序
komorebic.exe identify-tray-application exe Discord.exe
# komorebic.exe identify-tray-application exe [EXE 可执行文件名]
# komorebic.exe identify-tray-application class [窗口类名]
# komorebic.exe identify-tray-application title [窗口标题]komorebi 的日志会放在 ~/komorebi.log (~ 是 $env:USERPROFILE 的缩写). 该文件永远不会被复写或是轮替, 所以该文件会一直增长直到用户手动删除.
理论上来说当运行 komorebic stop 或者 Ctrl-C 信号发送给 komorebi 的时候, komorebi 会恢复所有隐藏的窗口. 但如果有某些窗口被隐藏了且无法被自动恢复, 运行 komorebic restore-windows 会让 komorebi 读取存放所有被komorebi管理的窗口的窗口句柄的文件 ~/komorebi.hwnd.json, 不管 komorebi 主进程是否正在运行.
恐慌 (panic) 在此指的是严重错误, 下译为「恐慌」.
如果 komorebi 停止响应, 原因很可能是恐慌或者是死锁. 如果是恐慌的话程序的日志会有记录; 但若是死锁的话日志不会有任何错误记录, 但是整个进程却停止响应了.
若你觉得你遭遇了死锁, 你可以用 --features deadlock_detection 来编译 komorebi 然后尝试重现此问题. 该特性会每隔五秒检查是否发生了死锁, 若有死锁发生则会在日志中写入相关信息, 你可以拿着它去开 issue.