OpenMouse

OpenMouse is a browser-based control panel for supported gaming mice.

Connect a mouse, view its information, and change supported settings such as DPI and polling rate without installing a different app for every brand.

This branch is deployed as the public development control panel.

Development

npm install
npm run dev

Run the full local check before pushing changes:

npm run check

Linux WebHID permissions

If a device appears in Chromium's picker but OpenMouse reports Failed to open the device, check the permissions on its /dev/hidraw* nodes. Linux does not grant user access to every HID device by default.

First inspect the connected device IDs:

lsusb

VXE R1 SE+ hardware ships with more than one receiver implementation. If the mouse and 1K receiver appear as 3554:f58f and 3554:f58e, respectively, install these narrowly scoped rules:

SUBSYSTEM=="hidraw", ATTRS{idVendor}=="3554", ATTRS{idProduct}=="f58f", TAG+="uaccess"
SUBSYSTEM=="hidraw", ATTRS{idVendor}=="3554", ATTRS{idProduct}=="f58e", TAG+="uaccess"

Save it as /etc/udev/rules.d/70-openmouse-vxe.rules, reload the rules, then unplug and reconnect both devices:

sudo udevadm control --reload-rules

Grant access to every hidraw node for each product. Chromium opens the HID device before OpenMouse selects its vendor configuration collection, so access to only the 0xff02:0x0002 collection's node is insufficient.

Contributing

OpenMouse is one repository in a family — with the Desktop app, mouse-protocol, and OpenMouse-Bridge.

Before you start, read the contribution guide. It explains how the repositories fit together, per-repo setup and conventions, and safe reverse-engineering practices.

Bridge updates

The Settings page compares the connected OpenMouse Bridge against its latest stable GitHub release. It only retrieves the version, changelog, and download link; it never downloads or installs an update in the background. Users can also run the check manually.

The control panel is organized by responsibility: control.ts coordinates the application, while the template, events, DOM helpers, persisted preferences, battery history, device selection, and rendering live in focused modules under src/.

Packet codecs and WebHID drivers live in the standalone @openmouse/protocol library. Its codec entry points remain transport-independent, while its drivers entry points own discovery filters, device clients, retries, and application-facing status conversion. OpenMouse consumes the same public exports that external consumers use.

Adding a vendor

Codec and driver contributions belong in the mouse-protocol repository.

1. Add transport-independent packet definitions and codecs under the vendor's mouse-protocol/src/<vendor>/ folder.
2. Add the WebHID implementation under mouse-protocol/src/drivers/<vendor>/.
3. Register the driver and browser filters in the shared driver layer.
4. Add or extend codec and driver tests, state which product IDs were verified on hardware, and run the checks in both repositories.

OpenMouse should only need changes when a driver introduces a genuinely new UI capability. The control UI otherwise discovers supported clients through the library registry automatically.

Hardware-specific validation checklists live in the protocol repository's docs/ directory.

License

GNU AGPL-3.0. Contributions are accepted under the same license.