Tutorial: How to invoke GoldenDict translation using a global shortcut on KDE Plasma 6 Wayland

[wpdevelopment11]

Prerequisites

Install the wl-clipboard package if it's not already installed.
On Ubuntu the command is as follows:

sudo apt install wl-clipboard

Create a Script That Will Be Invoked by the Global Shortcut

Create a file ~/goldendict_global_shortcut.sh with the following content:

If you are using Flatpak version

#!/bin/bash

text="$(wl-paste --primary 2>/dev/null)"

if [[ -z "$text" ]]; then
    text="$(wl-paste 2>/dev/null)"
fi

if [[ -z "$text" ]]; then
    exit 1
fi

flatpak run io.github.xiaoyifang.goldendict_ng -- "$text"

If you are using the package from your distro

#!/bin/bash

text="$(wl-paste --primary 2>/dev/null)"

if [[ -z "$text" ]]; then
    text="$(wl-paste 2>/dev/null)"
fi

if [[ -z "$text" ]]; then
    exit 1
fi

goldendict -- "$text"

Set the executable bit:

chmod +x ~/goldendict_global_shortcut.sh

Create the Global Shortcut for GoldenDict

Once you invoke the shortcut your selection or clipboard, if there is no active selection will be send to GoldenDict. In the video I set it to Meta+Space but you can choose whatever you want.

Make sure to paste the path of the script created previously. In my case it is ~/goldendict_global_shortcut.sh.

shortcut.webm

Disable Focus Stealing Prevention

This is optional. But without it GoldenDict will not be able to show itself on top of other windows reliably when you invoke the shortcut.

This works only for KDE Plasma 6.5 and newer.

Open the GoldenDict window alongside the KDE System Settings. The GoldenDict window is needed to catch its Window class.

See the recording below for how to create a Window Rule to disable Focus stealing prevention only for GoldenDict windows.

focus_stealing.webm

The Final Result

You should be able to invoke GoldenDict dictionary lookup using your created shortcut and it will appear on top of other windows.

final.webm

Tip: If You Are Using the Flatpak Version

Run the following command, which will allow you to run GoldenDict natively on Wayland:

flatpak override --user --socket=wayland io.github.xiaoyifang.goldendict_ng