OpenMouse Docs

Documentation site for the OpenMouse Project, built with Docusaurus. Deployed at docs.openmouse.app.

Lives on the docs branch of the openmouse repo — not a separate repo — so it stays next to the code it documents.

Covers the app's architecture and, most importantly, how to add support for a new mouse — reverse-engineering conventions, writing a driver, and getting it registered and verified.

npm install
npm run start

npm run build

Generates static content into build/.

• openmouse (control-panel branch) — the app these docs are for.
• mouse-protocol — the packet codecs and WebHID drivers these docs explain how to write.

GNU AGPL-3.0, same as the rest of the project.