Revisions: 3                                                        Éric NICOLAS
Latest: 2026-03-17                                              ccjmne@gmail.com

                          Foreign Keyboard Wayland HUD
                          ----------------------------
                          Master a new keyboard layout
                              without looking down


Particularly practical when looking down would be of no help since your physical
keyboard still shows the good old, reliable, comfortable labels on its keys--if
they even are labelled at all, that is.

Currently only displays 한글 characters with some muted QWERTY hints overlaid.


Development --------------------------------------------------------------------

    ./dev <client|server> ....... continuously build and run <client|server>

    Requires gcc, make, pgk-config, all dependencies of base-devel: chances
    are immense that you've got the tools suite already.


Dependencies -------------------------------------------------------------------

  - gtk4-layer-shell

      In order to create panels and other desktop components for Wayland.

  - noto-fonts

      Google's Noto fonts, for its support of a great number of languages.


Wish list ----------------------------------------------------------------------

  - Reflect current effective layout in key labels

  - Make some things configurable (at least colours, font)

  - Better finalise production packaging, probably publish to the AUR

  - Consider switching the whole thing to a Qt app.  It would maybe not even
    require even need any client–server communication channel...

Behavioural details ------------------------------------------------------------

    01. No Jamming .........................................................

    Inherent to the way Input Methods are wired within the stricter Wayland
    ecosystem, some key releases are bound to never reach fkwhud.  This
    happens when text entry is being accepted and a key is pressed down *as
    input mode is disabled*.  Most typically, this occurs whenever using
    some key binding to quit an application.

    For illustration, imagine being focused on some element in a Web browser
    that you may type in: at that time, fcitx5 will receive key presses and
    forward them to fkwhud.  Were you to press Ctrl-W to close the current
    tab, the last signal sent through to fcitx5 would be "W pressed down"
    while Ctrl is being held: we'd never see Ctrl nor W being released.

    To remedy these "jammed" keys, after some 750ms debounce period without
    having received any pressed signal, all the keys last seen being
    "pressed" will be considered having been released.

Licensing ----------------------------------------------------------------------

    MIT license, do essentially as you please; refer to LICENSE for details.


                                        vim: set tw=80 sw=4 et sta cc=1,80,-4,5: