KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm.
Go to file
2021-09-03 22:08:22 +03:00
.github ci: deploy documentation 2021-08-28 18:30:40 +03:00
bin feat: 🎨 Remove git rev from metadata description 2021-08-31 17:15:11 +03:00
img update user documentaion 2019-01-28 16:05:16 +09:00
res fix: Corretly pass all global objects 2021-09-02 20:49:10 +03:00
src fix: Corretly pass all global objects 2021-09-02 20:49:10 +03:00
test feat: rename ocurencies of krohnkite to bismuth 2021-08-28 19:18:28 +03:00
.git-blame-ignore-revs refactor: ignore formatter git blame 2021-08-28 00:41:23 +03:00
.gitignore Use npm scripts and wrap makefile around it 2021-08-26 22:35:46 +03:00
.prettierignore refactor: run prettier on markdown 2021-08-28 18:30:40 +03:00
.prettierrc.json refactor: use prettier 2021-08-28 00:22:22 +03:00
CONTRIBUTING.md fix: 📝 Use npm commands instead of make in docs 2021-09-03 22:08:22 +03:00
LICENSE Initial implementation 2018-11-06 15:38:22 +09:00
package.json build: add quick relaunch npm task 2021-09-03 22:02:14 +03:00
README.md fix: 📝 Use npm commands instead of make in docs 2021-09-03 22:08:22 +03:00
tsconfig.json fix: 🐛 Pass QML objects to various facilities 2021-09-02 01:10:36 +03:00
TWEAKS.md docs: split readme 2021-08-28 18:30:40 +03:00

🌈 Bismuth

This is a fork of Krohnkite - a dynamic tiling extension for KWin.

🗺️ Goals

Project goals are the following:

  1. Provide full-fledged tiling window manager experience in KDE Plasma with minimal effort on user side
  2. Wayland support

🌟 Features

  • Automatic window tiling
    • Dynamically tile windows, rather than manually placing each.
    • Floating windows
  • Fully integrates into KWin features, including:
    • Multi-screen
    • Activities & Virtual desktop
    • Basic window management (minimize, fullscreen, switching, etc)
  • Multiple Layout Support
    • Tiling layout
    • Monocle layout
    • Desktop-friendly layouts (Spread, Stair)

🔧 Installation

Install script via script:

npm run script-install

To uninstall:

npm run script-uninstall

Enabling User-Configuration

It is reported that a manual step is required to enable user configuration of KWin scripts. This is a limitation of KWin scripting.

To enable configuration, you must perform the following in command-line:

mkdir -p ~/.local/share/kservices5/
ln -s ~/.local/share/kwin/scripts/bismuth/metadata.desktop ~/.local/share/kservices5/bismuth.desktop

A configuration button will appear in KWin Scripts in System Settings.

config button shown

To make changes effective, the script must be reactivated:

  1. On KWin Scripts dialog, untick Bismuth
  2. Apply
  3. tick Bismuth
  4. Apply

Tweaks

Proceed to the TWEAKS section.

⌨️ Default Key Bindings

Key Action
Meta + J Focus Down/Next
Meta + K Focus Up/Previous
Meta + H Left
Meta + L Right
Meta + Shift + J Move Down/Next
Meta + Shift + K Move Up/Previous
Meta + Shift + H Move Left
Meta + Shift + L Move Right
Meta + I Increase
Meta + D Decrease
Meta + F Toggle Floating
Meta + \ Cycle Layout
Meta + Return Set as Master
Meta + T Use Tile Layout
Meta + M Use Monocle Layout
unbound Use Spread Layout
unbound Use Stair Layout