2021-09-04 16:33:51 +03:00
<!--
2022-03-03 19:13:50 +03:00
SPDX-FileCopyrightText: 2021-2022 Mikhail Zolotukhin < mail @ gikari . com >
2021-09-04 16:33:51 +03:00
SPDX-FileCopyrightText: 2018-2019 Eon S. Jeon < esjeon @ hyunmu . am >
SPDX-License-Identifier: MIT
-->
2022-01-06 22:33:30 +03:00
< div align = "center" >
2018-11-06 09:38:22 +03:00
2022-01-06 22:33:30 +03:00
# 🌈 Bismuth 🌈
2021-09-08 14:53:09 +03:00
2022-01-06 22:33:30 +03:00
#### Making tiling window management easy. On KDE Plasma.
2021-09-17 19:42:35 +03:00
2022-01-06 22:33:30 +03:00
[![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)
2022-01-19 01:34:50 +03:00
[![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)
2022-03-13 10:37:46 +03:00
[![Open Collective backers and sponsors ](https://img.shields.io/opencollective/all/bismuth?label=Donators&logo=opencollective&style=for-the-badge )](https://opencollective.com/bismuth)
2021-09-17 19:42:35 +03:00
2022-01-06 22:33:30 +03:00
![demo ](img/rice.png )
2018-11-14 09:23:55 +03:00
2022-01-06 22:33:30 +03:00
Arrange your windows in different grids to minimize the mouse usage.
2021-08-28 15:01:57 +03:00
2022-01-06 22:33:30 +03:00
## 🌟 Features 🌟
2018-12-04 02:38:44 +03:00
2022-01-06 22:33:30 +03:00
### Automatic window tiling
2021-11-15 00:56:41 +03:00
2022-01-06 22:33:30 +03:00
Save your time by automatically managing windows on your screen.
2018-11-12 11:16:57 +03:00
2022-01-06 22:33:30 +03:00
https://user-images.githubusercontent.com/14205339/148453685-f1bcfa46-4952-4b9d-a6f1-d2d75a0b4992.mp4
2021-10-03 00:15:25 +03:00
2022-01-06 22:33:30 +03:00
< br >
2021-09-03 22:08:22 +03:00
2022-01-06 22:33:30 +03:00
### Plasma integration
2021-09-03 22:08:22 +03:00
2022-01-06 22:33:30 +03:00
Power-up your workflow using native Plasma features - Virtual Desktops and
Activities.
2021-09-03 22:08:22 +03:00
2022-01-06 22:33:30 +03:00
https://user-images.githubusercontent.com/14205339/148562411-c9cca82a-c694-4794-b5e4-8fe716ec3d98.mp4
2019-01-28 10:01:33 +03:00
2022-01-06 22:33:30 +03:00
< br >
2021-11-01 21:48:26 +03:00
2022-01-06 22:33:30 +03:00
### Multiple Layouts
2021-11-05 20:05:38 +03:00
2022-01-06 22:33:30 +03:00
Use different layouts in different contexts.
2021-11-05 20:05:38 +03:00
2022-01-06 22:33:30 +03:00
https://user-images.githubusercontent.com/14205339/148564378-1def9350-a871-4f75-ba66-7a59ea1d4680.mp4
2021-11-05 20:05:38 +03:00
2022-01-06 22:33:30 +03:00
< / div >
< br >
< br >
< br >
## 🏁 Getting Started
### Requirements
2022-02-09 21:01:18 +03:00
- A Linux distribution with KDE Plasma version 5.20 or higher
2022-01-06 22:33:30 +03:00
- Qt version 5.15 or higher
2022-02-09 21:01:18 +03:00
- KDE Frameworks version 5.78 or higher
2022-01-06 22:33:30 +03:00
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
2021-11-08 18:47:52 +03:00
2022-01-06 22:33:30 +03:00
- [AUR ](https://aur.archlinux.org/packages/kwin-bismuth )
#### Debian
- [Volian Repository ](https://volian.org/bismuth/ )
#### Ubuntu
2022-03-20 13:20:57 +03:00
- [Official Repo ](https://launchpad.net/ubuntu/+source/bismuth ):
```bash
2022-06-15 12:55:47 +03:00
sudo apt install kwin-bismuth
2022-03-20 13:20:57 +03:00
```
2022-01-06 22:33:30 +03:00
- [Volian Repository ](https://volian.org/bismuth/ )
2021-11-08 15:18:48 +03:00
2021-12-08 01:03:27 +03:00
#### Fedora
2022-01-06 22:33:30 +03:00
- [Capucho Copr ](https://copr.fedorainfracloud.org/coprs/capucho/bismuth )
2021-12-19 16:53:10 +03:00
2022-01-13 19:58:23 +03:00
#### OpenSUSE Tumbleweed
- [home:rxmd OBS Repository ](https://build.opensuse.org/package/show/home:rxmd/kwin-script-tiling-bismuth )
2022-01-06 22:33:30 +03:00
#### Gentoo
- [VipreML Overlay ](https://github.com/viperML/viperML-overlay/ )
2021-12-19 16:53:10 +03:00
2022-02-06 16:14:39 +03:00
#### Solus
- [Solus ](https://dev.getsol.us/source/bismuth )
2022-01-06 22:33:30 +03:00
#### From Source
2021-12-08 01:03:27 +03:00
2022-01-06 22:33:30 +03:00
- [See Dev Docs ](CONTRIBUTING.md )
2021-11-05 20:05:38 +03:00
2022-01-06 22:33:30 +03:00
If you know a packaging solution for a distribution, that is not in the
list, please open a pull request.
2021-11-01 21:48:26 +03:00
2022-01-06 22:33:30 +03:00
### Usage
2021-08-28 14:54:40 +03:00
2022-01-06 22:33:30 +03:00
🎉 To start using Bismuth enable it in System Settings > Window Management >
2022-03-20 02:38:17 +03:00
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.
2021-11-14 15:18:07 +03:00
2022-02-09 19:51:39 +03:00
⌨️ 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
2022-01-26 20:14:10 +03:00
script](contrib/import_krohnkite.sh).
2021-08-28 14:54:40 +03:00
2022-01-06 22:33:30 +03:00
🔧 If you want, you may also make a couple of manual fixes and tweaks to
improve your experience with window tiling. See [Tweaks
2022-03-20 21:46:09 +03:00
section](docs/TWEAKS.md).
2022-01-06 22:33:30 +03:00
### Configuration
2021-11-01 22:22:38 +03:00
You can configure Bismuth in the System Settings > Window Management > Window Tiling.
![Bismuth Configuration Module ](img/config.png )
2022-01-06 22:33:30 +03:00
## 🤝 Acknowledgments
This project was made possible because of the hard work of other people on [Krohnkite
KWin Tiling Script](https://github.com/esjeon/krohnkite).