Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pschmitt/kwin-konsole-scratchpad
KWin script to make Konsole's background mode work like Guake
https://github.com/pschmitt/kwin-konsole-scratchpad
kde kde-desktop kde-plasma kwin-rules kwin-script
Last synced: about 12 hours ago
JSON representation
KWin script to make Konsole's background mode work like Guake
- Host: GitHub
- URL: https://github.com/pschmitt/kwin-konsole-scratchpad
- Owner: pschmitt
- License: gpl-3.0
- Created: 2021-04-08T10:46:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-27T08:45:26.000Z (over 3 years ago)
- Last Synced: 2024-11-16T23:29:02.147Z (2 months ago)
- Topics: kde, kde-desktop, kde-plasma, kwin-rules, kwin-script
- Language: JavaScript
- Homepage:
- Size: 147 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Konsole Scratchpad
This here is a KWin script that makes Konsole behave more like Guake does.
# Installation
1. Clone this repository
```shell
git clone https://github.com/pschmitt/kwin-konsole-scratchpad.git
cd ./kwin-konsole-scratchpad
```
2. Choose one of the following two install paths:
- [Shortcut only](#tldr-shortcut-only) (**recommended**)
- [KWin script](#install-as-a-kwin-script)
## TL;DR (Shortcut only)
1. Setup a custom shortcut that triggers
[`./konsole-scratchpad.sh`](./konsole-scratchpad.sh)
(Optional flags available. See `./konsole-scratchpad.sh --help`).
2. Set up a scratchpad service (see [below](#setup-a-scratchpad-service))
3. *Optional* Install [uglifyjs](https://github.com/mishoo/UglifyJS) to make the
loading of the script a tiny bit faster
## Install as a KWin script
1. Edit settings in [`./contents/code/main.js`](./contents/code/main.js)
2. Run [`./install.sh`](./install.sh)
3. Open System Settings: `Window Management > KWin Scripts` and make sure
that "Konsole Scratchpad" is enabled
4. Setup a custom key binding for "Toggle Konsole Scratchpad"
5. Set up a scratchpad service (see [below](#setup-a-scratchpad-service))
## Setup a scratchpad service
Since this script is mainly intended to have a Konsole window stick to the
bottom of the screen and show/hide on a keypress I suggest you autostart
konsole via one of the following methods:
### Desktop file
See [./extra/konsole-scratchpad.desktop](./extra/konsole-scratchpad.desktop)
To install:
```shell
cp ./extra/konsole-scratchpad.desktop ~/.config/autostart
```
### systemd user service
See [./extra/konsole-scratchpad.service](./extra/konsole-scratchpad.service)
To install:
```shell
cp ./extra/konsole-scratchpad.service ~/.config/systemd/user
systemctl --user enable --now konsole-scratchpad.service
```
Once done you should be able to show/hide your Konsole scratchpad with the
"Toggle Konsole Scratchpad" shortcut (F1 by default)
### NOTE
For this script to work reliably you need to ensure that Konsole's window/tab
title contains the `caption` set in
[./contents/code/main.js](./contents/code/main.js).
To do this you can either:
- set a static title in your Konsole profile
- make the startup program set it at runtime (provided that in your Konsole
profile the "Tab Title Format" contains `%w`) with:
```shell
title="scratchpad"
echo -ne "\e]0;${title}\a"
```
# Uninstall
1. Run [`./uninstall.sh`](./uninstall.sh)
2. Restart KWin 🤷
# Inspiration and credits
- https://github.com/fooblahblah/shimmer