https://github.com/Bismuth-Forge/bismuth

KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm.
https://github.com/Bismuth-Forge/bismuth

desktop kcm kde kde-plasma kwin kwin-script linux plasma tiling tiling-window-manager wayland window window-manager

Last synced: about 2 months ago
JSON representation

KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm.

• Host: GitHub
• URL: https://github.com/Bismuth-Forge/bismuth
• Owner: Bismuth-Forge
• License: other
• Created: 2021-08-28T07:42:31.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-03T09:15:09.000Z (8 months ago)
• Last Synced: 2024-01-29T21:14:00.049Z (5 months ago)
• Topics: desktop, kcm, kde, kde-plasma, kwin, kwin-script, linux, plasma, tiling, tiling-window-manager, wayland, window, window-manager
• Language: TypeScript
• Homepage: https://bismuth-forge.github.io/bismuth/
• Size: 10.7 MB
• Stars: 2,237
• Watchers: 24
• Forks: 85
• Open Issues: 156
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Roadmap: docs/ROADMAP.md

Lists

• Awesome-Linux-Software - ![Open-Source Software - forge.github.io/bismuth/) - Making tiling window management easy. On KDE Plasma. (Window Managers / Tiling Window Managers)
• Awesome-Linux-Software - ![Open-Source Software - forge.github.io/bismuth/) - Making tiling window management easy. On KDE Plasma. (Window Managers / Tiling Window Managers)
• awesome-stars - Bismuth-Forge/bismuth - KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm. (TypeScript)
• fucking-Awesome-Linux-Software - ![Open-Source Software - forge.github.io/bismuth/) - Making tiling window management easy. On KDE Plasma. (Window Managers / Tiling Window Managers)
• awesome-stars - Bismuth-Forge/bismuth - KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm. (linux)
• Awesome-Linux-Software - ![Open-Source Software - forge.github.io/bismuth/) - Making tiling window management easy. On KDE Plasma. (Window Managers / Tiling Window Managers)
• awesome-kde - Bismuth - A KDE Plasma extension that lets you tile windows automatically and manage them via keyboard, just like in classical tiling window managers (i3, dwm or XMondad). (**NOTE** for KDE Plasma 6, check Polonium listed below) (Customization / Plasma desktop)
• Awesome-Linux-Software-zh_CN - ![Open-Source Software - forge.github.io/bismuth/) - 在 KDE Plasma 之上，让平铺窗口管理变得简单。 (窗口管理 / 平铺式窗口管理器)

README

        




# 🌈 Bismuth 🌈

#### Making tiling window management easy. On KDE Plasma.

[![wayland: supported](https://img.shields.io/badge/Wayland-Ready-blue?style=for-the-badge&logo=kde)](https://community.kde.org/KWin/Wayland)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Bismuth-Forge/bismuth?color=red&logo=github&style=for-the-badge)](https://github.com/Bismuth-Forge/bismuth/releases/latest)

[![Matrix](https://img.shields.io/matrix/bi:kde.org?label=Chat&server_fqdn=kde.modular.im&logo=matrix&style=for-the-badge)](https://matrix.to/#/#bi:kde.org)

[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/bismuth?label=Donators&logo=opencollective&style=for-the-badge)](https://opencollective.com/bismuth)

![demo](img/rice.png)

Arrange your windows in different grids to minimize the mouse usage.

## 🌟 Features 🌟

### Automatic window tiling

Save your time by automatically managing windows on your screen.

https://user-images.githubusercontent.com/14205339/148453685-f1bcfa46-4952-4b9d-a6f1-d2d75a0b4992.mp4




### Plasma integration

Power-up your workflow using native Plasma features - Virtual Desktops and

Activities.

https://user-images.githubusercontent.com/14205339/148562411-c9cca82a-c694-4794-b5e4-8fe716ec3d98.mp4




### Multiple Layouts

Use different layouts in different contexts.

https://user-images.githubusercontent.com/14205339/148564378-1def9350-a871-4f75-ba66-7a59ea1d4680.mp4












## 🏁 Getting Started

### Requirements

- A Linux distribution with KDE Plasma version 5.20 or higher

- Qt version 5.15 or higher

- KDE Frameworks version 5.78 or higher

You can check if your system matches these requirements by going to System

Settings > About this System.

### Installation

:warning: Distributions' packages are not affiliated with Bismuth developers.

If you encounter any issues with the incorrect installation, you should

contact the package maintainer first.

#### Arch Linux

- [AUR](https://aur.archlinux.org/packages/kwin-bismuth)

#### Debian

- [Volian Repository](https://volian.org/bismuth/)

#### Ubuntu

- [Official Repo](https://launchpad.net/ubuntu/+source/bismuth):

  ```bash

  sudo apt install kwin-bismuth

  ```

- [Volian Repository](https://volian.org/bismuth/)

#### Fedora

- [Official Repo](https://src.fedoraproject.org/rpms/bismuth):

  ```bash

  sudo dnf install bismuth

  ```

  

#### Solus

- [Official Repo](https://dev.getsol.us/source/bismuth)

  ```bash

  sudo eopkg install bismuth

  ```

#### OpenSUSE Tumbleweed

- [KDE Extra Repository](https://build.opensuse.org/package/show/KDE:Extra/bismuth)

#### Gentoo

- [VipreML Overlay](https://github.com/viperML/viperML-overlay/)

#### From Source

- [See Dev Docs](CONTRIBUTING.md)

If you know a packaging solution for a distribution, that is not in the

list, please open a pull request.

### Usage

🎉 To start using Bismuth enable it in System Settings > Window Management >

Window Tiling. Additionally, you can decorate your windows in a tiling window

manager style (border-only windows) using the window decoration, that comes

with Bismuth. To do so, go to System Settings > Appearance > Window Decorations

and select the Bismuth decoration.

⌨️ You can view the shortcuts in System Settings > Shortcuts > Window Tiling. If

you used Krohnkite before, you can import some of its shortcuts using [the bash

script](contrib/import_krohnkite.sh).

🔧 If you want, you may also make a couple of manual fixes and tweaks to

improve your experience with window tiling. See [Tweaks

section](docs/TWEAKS.md).

### Configuration

You can configure Bismuth in the System Settings > Window Management > Window Tiling.

![Bismuth Configuration Module](img/config.png)

## 🤝 Acknowledgments

This project was made possible because of the hard work of other people on [Krohnkite

KWin Tiling Script](https://github.com/esjeon/krohnkite).