qmk-rgb/definitions

Definitions

VIA definition files. A keyboard holds effect numbers, not names, and the names live in one of these — the same file VIA reads when you open a board in its web app, which is why the tool depends on them the way VIA does.

What belongs here

One JSON file per keyboard, and a file is used for the board whose vendorId/productId it carries, so the name of the file does not matter. A file for another board is refused by name rather than used, because applying one board's effect names to another board writes wrong IDs.

qmk-rgb-tool definition fetch puts a file here for the connected keyboard. Drop one in by hand when the vendor publishes one and VIA does not carry it.

The files here

File	Board	From
impact80.json	Wobkey Impact 80	the vendor's Driver & Firmware page, which links it as the Impact 80 VIA JSON

Wobkey's file is the vendor's own, kept as it is served. It names three lighting channels — logo, Backlight, side — and their effect lists: 7, 46 and 7 entries, IDs 0 to 6, 0 to 45 and 0 to 6.

This board is not in VIA's own collection, so definition fetch cannot get it. That is why the file is here rather than fetched.

Two things a file does not tell the tool

The names it carries are the manufacturer's spelling, which need not be the tool's. The tool's aliases and its own spellings resolve alongside them — a definition writing fixed wave still answers to fixed_wave — and qmk-rgb-tool info reports whichever spelling the source in use has.

A file also names only the effects a board's firmware implements, so it may stop short of the board's highest effect ID. This one's backlight channel stops at 45 while the board takes ID 46 as well, which the compiled-in catalog in internal/rgb/impact80.go names freeze.