Loading content...
Key hints
A HUD of keycaps and labels, anchored in any screen corner.
A HUD of keycaps and labels, anchored in any screen corner.
lib.showKeyHints displays a list of key prompts — a keycap (text or a Lucide icon) followed
by a label. Pair it with lib.hideKeyHints().
lib.showKeyHints({
{ key = 'E', label = 'Interact' },
{ key = 'F', label = 'Enter' },
{ key = { icon = 'mouse' }, label = 'Look' },
})
-- when you're done
lib.hideKeyHints()lib.showKeyHints(items, options?)
itemsKeyHintItem[]requiredEach item is { key, label }. key is a string ('E'), an icon ({ icon = 'mouse' }), or a combo array ({ 'SHIFT', { icon = 'mouse' } }).
options.positionstringoptionaltop-left, top-right, bottom-left, bottom-right (default).
No auto-hide — always pair show with hideKeyHints(). One HUD at a time (a new call replaces the previous one). Keycap text is shown as-is: turn a control id into a clean name with lib.keys.getName first.