Contributing

The full guide, including how to build, test and format, lives in CONTRIBUTING.md in the repository. This page is the short version.

Most useful right now

1. Device reports and definitions. If you own one of the experimental devices, a report saying whether it works is the quickest way to get it supported. If you own a Razer device that isn’t listed at all, a working devices/*.toml is the single most valuable contribution. Devices explains the format and where the facts come from.
2. Protocol facts. Anything on the still to map list: dial functions, OLED images, the media-key data layout. Write down what you sent, what came back and what the device did.
3. Testing on other machines. The resource numbers on this site come from one PC. Measurements from yours (from status.json, which the daemon fills in itself) are welcome in an issue.

Ground rules

• Data over code for devices. If a device needs code, explain why the data file couldn’t express it.
• The hardware should keep working without uncoil. Prefer writing to the device (normal mode, onboard memory) over intercepting input in software.
• Earn every byte. Anything added to the daemon runs all day on someone’s PC; it has to justify its cost.
• Never pretend to be Razer. No Razer, Synapse or Chroma marks in names, icons or UI.
• HID captures can contain keystrokes. Never commit raw captures; the repository ignores *capture*.log for that reason. Share summaries instead.

Building

cargo test -p uncoil-core -p uncoil-hid -p uncoild -p uncoil-cli -p uncoil-openrgb   # core, transport, daemon, CLI, OpenRGB client
cargo build --release -p uncoild -p uncoil-cli                                         # target\release\uncoild.exe, uncoil.exe

The desktop app lives in apps/uncoil (Tauri + SvelteKit, pnpm). This website and these docs live in site/ (Astro + Starlight, pnpm); see site/README.md.

Licence

uncoil is GPL-3.0-or-later. By contributing you agree your contribution is licensed the same way. Protocol facts and some device data derive from OpenRazer and OpenRGB (GPL-2.0-or-later); credit sources in the file or commit.