@openmouse/protocol

Transport-independent gaming mouse protocol codecs used by OpenMouse.

The package owns packet layouts, command constants, checksums, encoders, decoders, protocol-specific value types, device catalogs, and the WebHID drivers used by OpenMouse. Pure codec entry points do not depend on WebHID, so browser, Node.js, and TypeScript projects can use them independently from the optional driver layer.

import { buildFinalmouseReport } from "@openmouse/protocol/finalmouse";
import { encodeRazerRequest } from "@openmouse/protocol/razer";
import { RAZER_PRODUCTS } from "@openmouse/protocol/razer-devices";

import {
  createSupportedClient,
  SUPPORTED_HID_FILTERS,
} from "@openmouse/protocol/drivers";

Development

npm install
npm run check

The prepare script builds dist automatically when this package is installed directly from Git. Codec sources are grouped by brand under src/; WebHID drivers, discovery filters, the driver registry, and shared status types live under src/drivers/. OpenMouse retains application orchestration and UI code.

See CONTRIBUTING.md for protocol boundaries, hardware evidence requirements, local OpenMouse integration, and the pull-request checklist.

Protocol entry points

| Brand | Import | | --- | --- | | ATK | @openmouse/protocol/atk | | Corsair | @openmouse/protocol/corsair | | Dareu | @openmouse/protocol/dareu | | Delux M800 Mini / M600 Pro | @openmouse/protocol/delux | | Endgame Gear OP1/XM2 8K | @openmouse/protocol/endgame-gear-op1 | | Endgame Gear wireless | @openmouse/protocol/endgame-gear-we | | Fantech | @openmouse/protocol/fantech | | Finalmouse | @openmouse/protocol/finalmouse | | G-Wolves | @openmouse/protocol/gwolves | | GearHub (Attack Shark / Lingbao) | @openmouse/protocol/gearhub | | Glorious | @openmouse/protocol/glorious | | Glorious classic (Model O/D/I) | @openmouse/protocol/glorious-classic | | HyperX | @openmouse/protocol/hyperx | | Incott | @openmouse/protocol/incott | | K-snake | @openmouse/protocol/ksnake | | Keychron | @openmouse/protocol/keychron | | Lamzu / CRDRAKO / Attack Shark | @openmouse/protocol/lamzu | | Logitech | @openmouse/protocol/logitech | | MCHOSE | @openmouse/protocol/mchose | | Microsoft | @openmouse/protocol/microsoft | | Motospeed | @openmouse/protocol/motospeed | | moddoMOUSE | @openmouse/protocol/moddo | | Ninjutso | @openmouse/protocol/ninjutso | | Orbital | @openmouse/protocol/orbital | | RAWM | @openmouse/protocol/rawm | | Pulsar / GravaStar | @openmouse/protocol/pulsar | | Razer legacy/current | @openmouse/protocol/razer | | Razer V4 | @openmouse/protocol/razer-v4 | | Ryunix | @openmouse/protocol/ryunix | | SteelSeries Rival 3 (Gen 1) | @openmouse/protocol/steelseries | | Teevolution | @openmouse/protocol/teevolution | | VGN | @openmouse/protocol/vgn | | WALLHACK | @openmouse/protocol/wallhack | | WLMouse | @openmouse/protocol/wlmouse | | Wooting | @openmouse/protocol/wooting | | Zaunkoenig | @openmouse/protocol/zaunkoenig |

An exported protocol means OpenMouse implements that wire format. It does not claim every mouse from that brand works. When a catalog provides a verified field, use it to distinguish hardware-tested support from USB recognition.

The Ninjutso catalog and packet layouts are derived from the JavaScript shipped by the official NinjaForce WebHID panel. They have automated transport and codec coverage, but are not marked as hardware-verified until tested on the corresponding Sora V2/V3 and TEN-family devices.

The SteelSeries Rival 3 Gen 1 codec and driver are derived from the public rivalcfg project, corroborated against libratbag and OpenRGB. The device is write-only — only the firmware version can be read back — and no entry is marked hardware-verified yet. See docs/steelseries-testing.md.