Skip to content

Add Custom Scripts section to README #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jinliu merged 1 commit into from
Jul 20, 2026
Merged

Add Custom Scripts section to README #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,26 @@ These actions aren't targeting a specific window, but the whole desktop.
- `get_desktop`
- `get_num_desktops`

### Custom Scripts

Use the `kwinscript` argument to run arbitrary KWin JavaScript code for
cases where the built-in commands don't cover what you need.

```
kdotool kwinscript --file <path>
kdotool kwinscript --inline <code>
```

The script runs with the same helper functions (`output_result`,
`output_error`, `output_debug`) that kdotool's generated scripts use.
Errors are caught and reported as usual.

Example — set window opacity:

```
kdotool kwinscript --inline 'var w=workspace.activeWindow;if(w){w.opacity=0.5;output_result("50% opacity");}'
```

## Won't support

You can use `ydotool`, `dotool`, etc. for these:
Expand All @@ -139,7 +159,6 @@ X11-specific:
- behave window action command
- `exec`
- `sleep`
- scripts

KWin has such functionality, but it is not exposed to the js API:

Expand Down