generate-app-overlays

Generate 1-bit keycap overlay PNGs for application shortcuts on PolyKybd keyboards.

5|1|Updated Aug 18, 2023
One-click install
npx skills add https://github.com/thpoll83/PolyKybdHost --skill generate-app-overlays-thpoll83
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-app-overlays
Source: https://github.com/thpoll83/PolyKybdHost/tree/main/.claude/skills/generate-app-overlays
Command: npx skills add https://github.com/thpoll83/PolyKybdHost --skill generate-app-overlays-thpoll83

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Pillow, numpy, PyYAML, cairosvg.

What problem does it solve? Creating per-application keycap overlays for the PolyKybd keyboard requires researching an app's full shortcut set, sourcing licensed icons, converting them to a strict 1-bit channel-packed PNG format, and wiring the mapping entry — a slow, error-prone manual process. ## Core Features & Use Cases - Shortcut research and coverage: Enumerate an app's complete shortcut set from its config files, official docs, or source repository, mapping every modifier chord to its overlay channel. - Licensed icon sourcing with provenance: Pull icons from the app's own repository or free sets like Fluent UI System Icons, recording source URLs and licenses in SOURCES.md for reproducibility. - Deterministic overlay generation: Run scripts/generate_app_overlays.py against a bindings.yaml to produce byte-identical 720x360 overlay PNGs, preview contact sheets, and the overlay-mapping.poly.yaml stanza. - Use Case: Ask to make overlays for Notepad++ and receive researched shortcuts, committed icons with licenses, generated .mods.png files, a preview sheet for approval, and the wired mapping entry. ## Quick Start Ask the assistant to make PolyKybd overlays for an application such as Notepad++ or Blender and approve the generated preview sheet.

Frequently Asked Questions about generate-app-overlays

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate keycap overlays for an application on PolyKybd?

Research the app's shortcuts, write a bindings.yaml listing keys, modifiers, and icons, then run scripts/generate_app_overlays.py with --preview. It writes the overlay PNGs into polyhost/res/overlays/ and prints the mapping stanza to paste into overlay-mapping.poly.yaml.

What image format do PolyKybd overlays use?

Overlays are 720x360 PNGs forming a 10x9 grid of 72x40 1-bit monochrome cells. Each colour channel of a cell encodes a different modifier variant, split across primary, combo, extra, and gui .mods.png files.

Which icon sets can I use for shortcut overlays?

Prefer the app's own repository icons first, then Fluent UI System Icons (MIT) as the house style, with Material Symbols (Apache-2.0) as a backup. Record each icon's source URL and license in SOURCES.md before committing it.

Why does my generated overlay layer come out blank?

Blank cells are usually a conversion mode mismatch, not missing artwork. White-on-transparent icons rendered with luma mode produce zero lit pixels; use alpha or auto mode instead, and count lit pixels per cell before re-sourcing icons.

Can overlays show Win-key or Ctrl+Alt+Shift shortcuts?

Yes. Since protocol 12 every modifier chord is representable: Ctrl+Alt+Shift maps to the extra file's R channel and GUI combos map to combo and gui channels. Do not drop these shortcuts when enumerating an app's bindings.