LGUG2Z
ad516a3c91
docs/linux/index.md: the Sponsorship for Personal Use copy gains the same policy paragraph as the README so the three platforms read one wording. Licence sentences are untouched. Not verified beyond reading the diff.
9.4 KiB
komorebi for KDE
Overview
komorebi is a tiling window manager for KDE Plasma on Wayland. It decides where each window
goes, and KWin, the window manager of Plasma, moves and draws the windows.
komorebi is a daemon that runs in the background, and it is controlled with a CLI,
komorebic. Every komorebic command that asks something of the daemon is a message on its
socket, so anything that can run a command can drive komorebi: a terminal, a script, or a
program that binds keys, which is how a key is given an action.
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 always remain opt-in and off-by-default.
How it fits together
komorebi only responds to the events KWin reports about windows and to the messages it receives on a dedicated socket. komorebic is a CLI that writes messages on komorebi's socket. komorebi doesn't read the keyboard or the mouse: a key runs a komorebic command, as a global shortcut of KDE. komorebi makes those shortcuts from a key binding file in the format of skhd, whkd or sxhkd (Key bindings); the custom shortcuts of Plasma's System Settings work too.
PROCESS SOCKET
key bindings --------> komorebic <------> komorebi
Getting started
Trying komorebi in a virtual machine starts a Plasma guest in which komorebi tiles a
few windows, with one command, and says what to do when it does not start.
Installing komorebi explains how to install the two programs: on NixOS with
the flake's module, which also starts komorebi with every Plasma session, and from source
anywhere else. Running komorebi explains how to start and stop the
daemon, ask it what it is doing and read its log.
Key bindings explains how to bind keys to komorebic commands with
an skhdrc, a whkdrc or an sxhkdrc, and Example configurations has
a NixOS configuration and sample key bindings in the three formats.
Focusing windows explains how to give the focus to another window,
Moving windows how to move a window to another tile,
Stacking windows how to put windows on one tile, have the others wait
out of sight and bring one of them to the front,
Layouts how to change the arrangement of the tiles,
The scrolling layout how its columns work,
Resizing windows how to change the size of one (and
Resizing a tile by dragging its edge what a drag with the pointer does),
Floating windows how to take a window out of the layout and work with
the floating ones,
Monocle how to give one window the whole work area,
Maximizing windows how to have KWin maximize one, and what
komorebi does when you maximize one yourself,
Fullscreen windows what komorebi does with one,
Managing windows how to minimize, close and unmanage the focused
window and pause the daemon, and
Padding and work area offsets how to put gaps around the tiles
and keep parts of a monitor free of them.
Rules explains how to keep an application out of the layout, always tile it, or
float its windows.
Initial window placement rules explains how to say where in the
layout a window goes when it opens.
Workspaces explains how each monitor shows one of its workspaces, which
are KWin's virtual desktops, and how to show another or move a window to one, and
Workspace rules how to have the windows of an application go to a
workspace by themselves.
Configuration explains komorebi.json, where komorebi looks for it and
how it is reloaded when it changes, Example configurations has one to
start from, and Application specific configuration
explains the files of rules for particular applications it can name.
Quickstart and autostart explains how to write an example
configuration, how to start komorebi with Plasma without the module, and how to replace the
configuration of a running daemon.
Borders explains how komorebi has KWin draw a border around each window,
Animation how it has KWin animate the windows going to their places, and
Transparency how it makes the windows that do not have the focus
see-through, Focus follows mouse how it has KWin give the focus
to the window under the pointer, Themes how a theme gives the borders their
colors, and Wallpapers how a monitor or a workspace shows a picture of its own,
and what it does to the borders.
Changing monitors explains what komorebi does when a monitor
changes size, is unplugged or is plugged in, and
Sleeping and locking what it does when the machine wakes up and
the screen is unlocked.
Checking the setup explains how komorebic check finds the
mistakes in a configuration and a key binding file, and what is missing from the desktop, before
the daemon does.
Subscribing to notifications explains how a program
such as a status bar follows what komorebi does. The CLI reference has a page
for every komorebic command, generated from its help.
Compared with komorebi for Windows and for Mac says, for someone who knows
komorebi on one of them, what is the same on KDE Plasma, what is different, what KDE does by
itself and what is not supported.
Community
There is a Discord server available for
komorebi-related discussion, help, troubleshooting etc.
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 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, and gain the ability to submit feature requests on the issue tracker.
Feature requests for all platforms (Windows, Linux and macOS) are accepted from
current GitHub sponsors on the $5/month tier
and above, people with a valid individual commercial use
license, and approved contributors. Issues
titled [FEAT]: opened by anyone else are closed automatically. Bug reports are
open to everyone.
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 Commercial 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.