{"id":16615622,"url":"https://github.com/pschmitt/kwin-konsole-scratchpad","last_synced_at":"2026-04-24T13:04:22.073Z","repository":{"id":141969175,"uuid":"355867014","full_name":"pschmitt/kwin-konsole-scratchpad","owner":"pschmitt","description":"KWin script to make Konsole's background mode work like Guake","archived":false,"fork":false,"pushed_at":"2021-04-27T08:45:26.000Z","size":151,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-17T18:00:06.005Z","etag":null,"topics":["kde","kde-desktop","kde-plasma","kwin-rules","kwin-script"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pschmitt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["pschmitt"],"custom":["https://www.paypal.com/paypalme/pppschmitt"]}},"created_at":"2021-04-08T10:46:24.000Z","updated_at":"2024-04-17T17:49:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"2ee50680-0f12-4c37-9b2e-70dc922a94f3","html_url":"https://github.com/pschmitt/kwin-konsole-scratchpad","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fkwin-konsole-scratchpad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fkwin-konsole-scratchpad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fkwin-konsole-scratchpad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fkwin-konsole-scratchpad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pschmitt","download_url":"https://codeload.github.com/pschmitt/kwin-konsole-scratchpad/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242956551,"owners_count":20212454,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kde","kde-desktop","kde-plasma","kwin-rules","kwin-script"],"created_at":"2024-10-12T02:10:04.765Z","updated_at":"2026-04-24T13:04:17.032Z","avatar_url":"https://github.com/pschmitt.png","language":"JavaScript","funding_links":["https://github.com/sponsors/pschmitt","https://www.paypal.com/paypalme/pppschmitt"],"categories":[],"sub_categories":[],"readme":"# Konsole Scratchpad\n\nThis here is a KWin script that makes Konsole behave more like Guake does.\n\n# Installation\n\n1. Clone this repository\n```shell\ngit clone https://github.com/pschmitt/kwin-konsole-scratchpad.git\ncd ./kwin-konsole-scratchpad\n```\n2. Choose one of the following two install paths:\n  - [Shortcut only](#tldr-shortcut-only) (**recommended**)\n  - [KWin script](#install-as-a-kwin-script)\n\n## TL;DR (Shortcut only)\n\n1. Setup a custom shortcut that triggers \n[`./konsole-scratchpad.sh`](./konsole-scratchpad.sh) \n(Optional flags available. See `./konsole-scratchpad.sh --help`).\n2. Set up a scratchpad service (see [below](#setup-a-scratchpad-service))\n3. *Optional* Install [uglifyjs](https://github.com/mishoo/UglifyJS) to make the\nloading of the script a tiny bit faster\n\n## Install as a KWin script\n\n1. Edit settings in [`./contents/code/main.js`](./contents/code/main.js)\n2. Run [`./install.sh`](./install.sh)\n3. Open System Settings: `Window Management \u003e KWin Scripts` and make sure \nthat \"Konsole Scratchpad\" is enabled\n4. Setup a custom key binding for \"Toggle Konsole Scratchpad\"\n5. Set up a scratchpad service (see [below](#setup-a-scratchpad-service))\n\n## Setup a scratchpad service\n\nSince this script is mainly intended to have a Konsole window stick to the\nbottom of the screen and show/hide on a keypress I suggest you autostart \nkonsole via one of the following methods:\n\n### Desktop file\n\nSee [./extra/konsole-scratchpad.desktop](./extra/konsole-scratchpad.desktop)\n\nTo install:\n\n```shell\ncp ./extra/konsole-scratchpad.desktop ~/.config/autostart\n```\n\n### systemd user service\n\nSee [./extra/konsole-scratchpad.service](./extra/konsole-scratchpad.service)\n\nTo install:\n\n```shell\ncp ./extra/konsole-scratchpad.service ~/.config/systemd/user\nsystemctl --user enable --now konsole-scratchpad.service\n```\n\nOnce done you should be able to show/hide your Konsole scratchpad with the \n\"Toggle Konsole Scratchpad\" shortcut (\u003ckbd\u003eF1\u003c/kbd\u003e by default)\n\n### NOTE\n\nFor this script to work reliably you need to ensure that Konsole's window/tab \ntitle contains the `caption` set in \n[./contents/code/main.js](./contents/code/main.js).\n\nTo do this you can either:\n- set a static title in your Konsole profile \n- make the startup program set it at runtime (provided that in your Konsole \nprofile the \"Tab Title Format\" contains `%w`) with:\n\n```shell\ntitle=\"scratchpad\"\necho -ne \"\\e]0;${title}\\a\"\n```\n\n# Uninstall\n\n1. Run [`./uninstall.sh`](./uninstall.sh)\n2. Restart KWin 🤷\n\n# Inspiration and credits\n\n- https://github.com/fooblahblah/shimmer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fkwin-konsole-scratchpad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpschmitt%2Fkwin-konsole-scratchpad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fkwin-konsole-scratchpad/lists"}