https://github.com/Jazqa/kwin-yakts

An easy tiling script for KWin
https://github.com/Jazqa/kwin-yakts

javascript kde kwin tiling typescript

Last synced: 10 months ago
JSON representation

An easy tiling script for KWin

• Host: GitHub
• URL: https://github.com/Jazqa/kwin-yakts
• Owner: Jazqa
• License: gpl-2.0
• Created: 2017-07-02T08:20:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T14:15:00.000Z (about 1 year ago)
• Last Synced: 2024-11-11T14:43:04.203Z (about 1 year ago)
• Topics: javascript, kde, kwin, tiling, typescript
• Language: TypeScript
• Homepage:
• Size: 611 KB
• Stars: 367
• Watchers: 12
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Yet Another KWin Tiling Script

A tiling script for Plasma 6.

Plasma 5 version is archived in [`plasma-5`](https://github.com/Jazqa/kwin-quarter-tiling/tree/plasma-5) branch and can be downloaded from [here](https://github.com/Jazqa/kwin-quarter-tiling/releases/tag/2.0).

## Preview

![d1](https://i.imgur.com/mjlK2s9.gif)

![d2](https://i.imgur.com/xsuEXhw.gif)

![d3](https://i.imgur.com/7rN8hg2.gif)

## Installation

**Manual:**

    git clone https://github.com/Jazqa/kwin-yakts.git

    kpackagetool6 --type=KWin/Script -r yakts || true

    kpackagetool6 --type=KWin/Script -i ./kwin-yakts

    rm -rf ./kwin-yakts

## Configuration

The script can be configured through its configuration interface under `System Settings > Window Management > KWin Scripts`. You can filter problematic windows with process names, window captions or window sizes.

## Shortcuts

KWin shortcuts can be found in `System Settings > Shortcuts > Global Shortcuts > KWin`.

All `(YAKTS) ` -shortcuts are used exclusively by the script, but the script supports a variety of KWin shortcuts as well. For example, KWin's `Move Window ` -shortcuts also move the script's tiles.

Binding the `(YAKTS) Tile Window` -shortcut is recommended, because it makes untiling problematic windows easy.

## Updates

**Git:**

    git clone https://github.com/Jazqa/kwin-yakts.git

    kpackagetool6 --type=KWin/Script -r yakts || true

    kpackagetool6 --type=KWin/Script -i ./kwin-yakts

    rm -rf ./kwin-yakts

Alternatively, set this repository as the origin of `~/.local/share/kwin/scripts/yakts` to update it with `git pull`.

## Uninstallation

    kpackagetool6 --type=KWin/Script -r yakts

    qdbus org.kde.kglobalaccel /component/kwin org.kde.kglobalaccel.Component.cleanUp

The script can also be uninstalled from `System Settings > Window Management > KWin Scripts`.

## Contributions and adjustments

The script is written in TypeScript, transpiled to JavaScript and rolled up into a single `main.js` file. If you modify the `.ts` files, you have to run `npm run transpile`

New tiling layouts can be created without touching the existing code. New layouts should be placed under `src/layouts`. New layouts will work as long as the layouts implement the interface described in `src/layout.ts`. If you create a new layout, feel free to open a pull request and it'll be added to master.