Tiling window manager for windows

komorebi

Tiling Window Management for Windows.

Картинка с сайта: github.com

Overview

komorebi is a tiling window manager that works as an extension to Microsoft’s
Desktop Window
Manager in
Windows 10 and above.

komorebi allows you to control application windows, virtual workspaces and display monitors with a CLI which can be
used with third-party software such as whkd
and AutoHotKey to set user-defined keyboard shortcuts.

komorebi aims to make as few modifications as possible to the operating
system and desktop environment by default. Users are free to make such
modifications in their own configuration files for komorebi, but these will
remain opt-in and off-by-default for the foreseeable future.

Please refer to the documentation for instructions on how
to install and
configure
komorebi, common workflows, a complete
configuration schema reference and a
complete CLI reference.

Community

There is a Discord server available for
komorebi-related discussion, help, troubleshooting etc. If you have any
specific feature requests or bugs to report, please create an issue in this
repository.

There is a YouTube
channel where I post
komorebi development videos, feature previews and release overviews. Subscribing
to the channel (which is monetized as part of the YouTube Partner Program) and
watching videos is a really simple and passive way to contribute financially to
the development and maintenance of komorebi.

There is an Awesome List which
showcases the many awesome projects that exist in the komorebi ecosystem.

Licensing for Personal Use

komorebi is educational source
software.

komorebi is licensed under the Komorebi 2.0.0
license, which is a fork of the
PolyForm Strict 1.0.0
license. On a high level
this means that you are free to do whatever you want with komorebi for
personal use other than redistribution, or distribution of new works (i.e.
hard-forks) based on the software.

Anyone is free to make their own fork of komorebi with changes intended either
for personal use or for integration back upstream via pull requests.

The Komorebi 2.0.0 License does
not permit any kind of commercial use (i.e. using komorebi at work).

Sponsorship for Personal Use

komorebi is a free and educational source project, and one that encourages you
to make charitable donations if you find the software to be useful and have the
financial means.

I encourage you to make a charitable donation to the Palestine Children’s
Relief Fund or to contribute
to a Gaza Funds campaign before you consider sponsoring
me on GitHub.

GitHub Sponsors is enabled for this
project. Sponsors can claim custom roles on
the Discord server, get shout outs at the end of komorebi-related videos on
YouTube, gain the ability to submit feature requests on the issue tracker, and
receive releases of komorebi with «easter eggs» on physical media.

If you would like to tip or sponsor the project but are unable to use GitHub
Sponsors, you may also sponsor through Ko-fi, or
make an anonymous Bitcoin donation to bc1qv73wzspc77k46uty4vp85x8sdp24mphvm58f6q.

Licensing for Commercial Use

A dedicated Individual Commercial Use License is available for those who want to
use komorebi at work.

The Individual Commerical Use License adds “Commercial Use” as a “Permitted Use”
for the licensed individual only, for the duration of a valid paid license
subscription only. All provisions and restrictions enumerated in the Komorebi
License continue to apply.

More information, pricing and purchase links for Individual Commercial Use
Licenses can be found here.

Installation

A detailed installation and quickstart
guide is available which shows how to get started
using scoop, winget or building from source.

Картинка с сайта: github.com

Comparison With Fancy Zones

Community member Olge has created an
excellent video which compares the default window management features of
Windows 11, Fancy Zones and komorebi.

If you are not familiar with tiling window managers or if you are looking at
komorebi and wondering «how is this different from Fancy Zones? 🤔», this short
video will answer the majority of your questions.

Картинка с сайта: github.com

Demonstrations

@amnweb showing komorebi v0.1.28 running on Windows 11 with window borders,
unfocused window transparency and animations enabled, using a custom status bar integrated using
komorebi‘
s Window Manager Event Subscriptions.

Windows.11.and.Komorebi.mp4

@haxibami showing komorebi running on Windows
11 with a terminal emulator, a web browser and a code editor. The original
video can be viewed
here.

0vadqFOyIJHglPRY.mp4

@aik2mlj showing komorebi running on Windows 11
with multiple workspaces, terminal emulators, a web browser, and the
yasb status bar with the komorebi workspace
widget enabled. The original video can be viewed
here.

0e0dd7fc-7115-11ec-a064-42a1fbc2e1e9-v4_t10000011-wbjnuX5De6.mp4

Contribution Guidelines

If you would like to contribute to komorebi please take the time to carefully
read the guidelines below.

Please see CONTRIBUTING.md for more information about how
code contributions to komorebi are licensed.

Commit hygiene

• Flatten all use statements
• Run cargo +stable clippy and ensure that all lints and suggestions have been addressed before committing
• Run cargo +nightly fmt --all to ensure consistent formatting before committing
• Use git cz with
  the Commitizen CLI to prepare
  commit messages
• Provide at least one short sentence or paragraph in your commit message body to describe your thought process for
  the changes being committed

PRs should contain only a single feature or bug fix

It is very difficult to review pull requests which touch multiple unrelated features and parts of the codebase.

Please do not submit pull requests like this; you will be asked to separate them into smaller PRs that deal only with
one feature or bug fix at a time.

If you are working on multiple features and bug fixes, I suggest that you cut a branch called local-trunk
from master which you keep up to date, and rebase the various independent branches you are working on onto that branch
if you want to test them together or create a build with everything integrated.

Refactors to the codebase must have prior approval

komorebi is a mature codebase with an internal consistency and structure that has developed organically over close to
half a decade.

There are countless hours of live coding videos demonstrating work on this project and
showing new contributors how to do everything from basic tasks like implementing new komorebic commands to
distinguishing monitors by manufacturer hardware identifiers and video card ports.

Refactors to the structure of the codebase are not taken lightly and require prior discussion and approval.

Please do not start refactoring the codebase with the expectation of having your changes integrated until you receive an
explicit approval or a request to do so.

Similarly, when implementing features and bug fixes, please stick to the structure of the codebase as much as possible
and do not take this as an opportunity to do some «refactoring along the way».

It is extremely difficult to review PRs for features and bug fixes if they are lost in sweeping changes to the structure
of the codebase.

Breaking changes to user-facing interfaces are unacceptable

This includes but is not limited to:

• All komorebic commands
• The komorebi.json schema
• The
  komorebi-application-specific-configuration
  schema

No user should ever find that their configuration file has stopped working after upgrading to a new version
of komorebi.

More often than not there are ways to reformulate changes that may initially seem like they require breaking user-facing
interfaces into additive changes.

For some inspiration please take a look
at this commit which added the
ability for users to specify colours in komorebi.json in Hex format alongside RGB.

There is also a process in place for graceful, non-breaking, deprecation of configuration options that are no longer
required.

Development

If you use IntelliJ, you should enable the following settings to ensure that code generated by macros is recognised by
the IDE for completions and navigation:

• Set Expand declarative macros
  to Use new engine under «Settings > Langauges & Frameworks > Rust»
• Enable the following experimental features:
  • org.rust.cargo.evaluate.build.scripts
  • org.rust.macros.proc

Logs and Debugging

Logs from komorebi will be appended to %LOCALAPPDATA%/komorebi/komorebi.log; this file is never rotated or
overwritten, so it will keep growing until it is deleted by the user.

Whenever running the komorebic stop command or sending a Ctrl-C signal to komorebi directly, the komorebi process
ensures that all hidden windows are restored before termination.

If however, you ever end up with windows that are hidden and cannot be restored, a list of window handles known
to komorebi are stored and continuously updated in %LOCALAPPDATA%/komorebi//komorebi.hwnd.json.

Restoring Windows

Running komorebic restore-windows will read the list of window handles and forcibly restore them, regardless of
whether the main komorebi process is running.

Panics and Deadlocks

If komorebi ever stops responding, it is most likely either due to either a panic or a deadlock. In the case of a
panic, this will be reported in the log. In the case of a deadlock, there will not be any errors in the log, but the
process and the log will appear frozen.

If you believe you have encountered a deadlock, you can compile komorebi with --features deadlock_detection and try
reproducing the deadlock again. This will check for deadlocks every 5 seconds in the background, and if a deadlock is
found, information about it will appear in the log which can be shared when opening an issue.

Window Manager State and Integrations

The current state of the window manager can be queried using the komorebic state command, which returns a JSON
representation of the State struct.

This may also be polled to build further integrations and widgets on top of.

Window Manager Event Subscriptions

Named Pipes

It is possible to subscribe to notifications of every WindowManagerEvent and SocketMessage handled
by komorebi using Named Pipes.

First, your application must create a named pipe. Once the named pipe has been created, run the following command:

komorebic.exe subscribe-pipe <your pipe name>

Note that you do not have to include the full path of the named pipe, just the name.

If the named pipe exists, komorebi will start pushing JSON data of successfully handled events and messages:

{"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":{}}

You may then filter on the type key to listen to the events that you are interested in. For a full list of possible
notification types, refer to the enum variants of WindowManagerEvent in komorebi and SocketMessage
in komorebi::core.

Below is an example of how you can subscribe to and filter on events using a named pipe in 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

It is possible to subscribe to notifications of every WindowManagerEvent and SocketMessage handled
by komorebi using Unix Domain Sockets.

UDS are also the only mode of communication between komorebi and komorebic.

First, your application must create a socket in $ENV:LocalAppData\komorebi. Once the socket has been created, run the
following command:

komorebic.exe subscribe-socket <your socket name>

If the socket exists, komorebi will start pushing JSON data of successfully handled events and messages as in the
example above in the Named Pipes section.

Rust Client

As of v0.1.22 it is possible to use the komorebi-client crate to subscribe to notifications of
every WindowManagerEvent and SocketMessage handled by komorebi in a Rust codebase.

Below is a simple example of how to use komorebi-client in a basic Rust application.

// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.36"}

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}");
      }
    }
  }

}

A read-world example can be found
in komokana.

Subscription Event Notification Schema

A JSON Schema of the event notifications emitted to subscribers can be generated with
the komorebic notification-schema command. The output of this command can be redirected to the clipboard or a file,
which can be used with services such as Quicktype to generate type definitions in different
programming languages.

Communication over TCP

A TCP listener can optionally be exposed on a port of your choosing with the --tcp-port=N flag. If this flag is not
provided to komorebi or komorebic start, no TCP listener will be created.

Once created, your client may send
any SocketMessage to komorebi in the
same way that komorebic would.

This can be used if you would like to create your own alternative to komorebic which incorporates scripting and
various middleware layers, and similarly it can be used if you would like to integrate komorebi with
a custom input handler.

If a client sends an unrecognized message, it will be disconnected and have to reconnect before trying to communicate
again.

Socket Message Schema

A JSON Schema of socket messages used to send instructions to komorebi can be generated
with the komorebic socket-schema command. The output of this command can be redirected to the clipboard or a file,
which can be used with services such as Quicktype to generate type definitions in different
programming languages.

Appreciations

• First and foremost, thank you to my wife, both for naming this project and for her patience throughout its
  never-ending development

• Thank you to @sitiom for
  being an exemplary open source community leader

• Thank you to the developers of nog who came before me and whose work taught
  me more than I can ever hope to repay

• Thank you to the developers of GlazeWM for pushing the boundaries of tiling
  window management on Windows with me and having an excellent spirit of collaboration

• Thank you to @Ciantic for helping me bring
  the hidden Virtual Desktops cloaking function to komorebi

Getting started

komorebi is a tiling window manager for Windows that is comprised of two
main binaries, komorebi.exe, which contains the window manager itself,
and komorebic.exe, which is the main way to send commands to the tiling
window manager.

It is important to note that neither komorebi.exe nor komorebic.exe handle
key bindings, because komorebi is a tiling window manager and not a hotkey
daemon.

This getting started guide suggests the installation of
whkd to allow you to bind komorebic.exe
commands to hotkeys to allow you to communicate with the tiling window manager
using keyboard shortcuts.

However, whkd is a very simple hotkey daemon, and notably, does not include
workarounds for Microsoft’s restrictions on hotkey combinations that can use
the Windows key.

If using hotkey combinations with the Windows key is important to you, I
suggest that once you are familiar with the main komorebic.exe commands used
to manipulate the window manager, you use
AutoHotKey to handle your key bindings.

komorebi also includes komorebi-bar.exe, a simple and reliable status bar which
is deeply integrated with the tiling window manager, and can be customized with
various widgets and themes.

komorebi is available pre-built to install via
Scoop and
WinGet, and you may also build
it from source if you would prefer.

• Scoop
• WinGet
• Building from source
• Offline

Long path support

It is highly recommended that you enable support for long paths in Windows by
running the following command in an Administrator Terminal before installing
komorebi.

Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1

Disabling unnecessary system animations

It is highly recommended that you enable the «Turn off all unnecessary animations (when possible)» option in
«Control Panel > Ease of Access > Ease of Access Centre / Make the computer easier to see» for the best performance with
komorebi.

Scoop

Make sure you have installed scoop and verified that
installed binaries are available in your $PATH before proceeding.

Issues with komorebi and related commands not being recognized in the
terminal ultimately come down to the $PATH environment variable not being
correctly configured by your package manager and should not be raised as
bugs or issues either on the komorebi GitHub repository or Discord server.

Install komorebi and whkd

First add the extras bucket

Then install the komorebi and whkd packages using scoop install

scoop install komorebi whkd

Once komorebi is installed, proceed to get the example
configurations.

WinGet

Make sure you have installed the latest version of
winget
and verified that installed binaries are available in your $PATH before
proceeding.

Issues with komorebi and related commands not being recognized in the
terminal ultimately come down to the $PATH environment variable not being
correctly configured by your package manager and should not be raised as
bugs or issues either on the komorebi GitHub repository or Discord server.

Install komorebi and whkd

Install the komorebi and whkd packages using winget install

winget install LGUG2Z.komorebi
winget install LGUG2Z.whkd

Once komorebi is installed, proceed to get the example
configurations.

Building from source

Make sure you have installed rustup, a stable rust
compiler toolchain, and the Visual Studio Visual Studio
prerequisites.

Clone the git repository, enter the directory, and build the following binaries:

cargo +stable install --path komorebi --locked
cargo +stable install --path komorebic --locked
cargo +stable install --path komorebic-no-console --locked
cargo +stable install --path komorebi-gui --locked
cargo +stable install --path komorebi-bar --locked

If the binaries have been built and added to your $PATH correctly, you should
see some output when running komorebi --help and komorebic --help

Offline

Download the latest komorebi
and whkd MSI installers on an internet-connected computer, then copy them to
an offline machine to install.

Once installed, proceed to get the example configurations (none of the commands for
first-time set up and running komorebi require an internet connection).

Upgrades

Before upgrading, make sure to run komorebic stop --whkd --bar. This is to ensure that all the current
komorebi-related exe files can be replaced without issue.

Then, depending on whether you installed via scoop or winget, you can run the appropriate command:

# for winget
winget upgrade LGUG2Z.komorebi

# for scoop
scoop update komorebi

Once the upgrade is completed you can confirm that you have the latest version by running komorebic --version, and
then start it with komorebic start --whkd --bar.

Uninstallation

Before uninstalling, first run komorebic stop --whkd --bar to make sure that
the komorebi, komorebi-bar and whkd processes have been stopped.

Then, depending on whether you installed with Scoop or WinGet, run scoop
uninstall komorebi whkd or winget uninstall LGUG2Z.komorebi LGUG2Z.whkd.

Finally, you can run the following commands in a PowerShell prompt to clean up
files created by the quickstart command and any other runtime files:

rm $Env:USERPROFILE\komorebi.json
rm $Env:USERPROFILE\applications.json
rm $Env:USERPROFILE\.config\whkdrc
rm -r -Force $Env:LOCALAPPDATA\komorebi