Guake/guake

Add first-time configuration guide for global hotkey on wayland

Open

#2,011 opened on Jan 18, 2022

View on GitHub
 (1 comment) (11 reactions) (0 assignees)Python (619 forks)batch import
Type: Feature Requestgood first issue

Repository metrics

Stars
 (4,281 stars)
PR merge metrics
 (Avg merge 4d 6h) (2 merged PRs in 30d)

Description

Wayland prevents global hotkey registration as part of its anti-keylogger crusade, which means that Guake's global toggle needs to be done by adding guake-toggle to the window manager's global keyboard shortfcuts. Currently this is not mentioned in the program, so I'd like to propose the following flow for the program:

  1. Detect wayland by catching global hotkey binding failure
  2. Pop a dialog to explain the situation and provide instructions on how to set the hotkey in keyboard settings.
  3. Offer to unbind the global hotkey so that further messages do not appear.

Contributor guide

Research direction
Investigate Wayland detection by catching global hotkey binding failure, design a dialog UI to explain the situation, and provide instructions for setting the hotkey in keyboard settings using GNOME's API or a configuration file. Consider offering to unbind the hotkey. Look at how other apps handle Wayland global shortcuts.
Tech stack
python
Domain
desktop
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGNOME development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60