When you hold down "super" for an extended period of time, we should show a little cheatsheet containing all of the currently mapped keybinds

[mattkae]

This would be very much akin to CS2's "crosshair guides" that come on when you left click for a long period of time

Requirements

• When a user holds down their meta key for a configurable period of time, an overlay "cheatsheet" should appear containing their keybinds
• This cheatsheet should be a privileged client who has access to this information about the compositor
• The client could either (1) be spawned by the compositor or (2) listen to the global keys portal [(1) may be easier in the meantime]

[mecattaf]

If you want to make this an integral part of miracle-wm I have a few thoughts: 1) For custom actions the description of the action associated to the specific shortcut should be a separate field in the config, for example:

custom_actions:           # Set meta + D to open wofi
  - command: wofi --show=drun
    action: down
    modifiers:
      - primary
    key: KEY_D
 > description: drun menu <

2) Ability to search would be HUGE 3) I have a ton of shortcuts, and I really doubt it would all fit on one page. How would you handle this? Scrolling? Multiple pages? 4) Either way it would be nice to be able to set the size that this cheatsheet occupies on the screen (either as % of screen or absolute pixel size for x/y coordinates. Bonus points if we can set the blur amount for the section outside of the cheatsheet

---

Here are some ways I have seen nice cheat sheets in the past for inspiration:

• gocheat written in go, fixed shortcuts, depends on charmbracelet's bubbletea TUI builder so looks amazing
• keyb, also written in go, more minimalist, supports piping to rofi/fzf/etc.
• My own poorly written shortcut tool that spawns a kitty terminal, gives the choice of several tools with fzf, then displays a markdown table with charmbracelet's glow (searching possible). Script here and shortcut collection here. Glow has rudimentary search but not fuzzy. I have to manually maintain the shortcuts.

I would recommend that you make the cheatsheet function an external project. But in the end it's up to you :)

However if you do end up writing a custom tool for this I would like to be able to use it to also display shortcuts that are not a part of miracle-wm.

Finally some aesthetic inspiration: nvchad cheat sheet

awesomewm built-in cheat sheet: