Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tinkerer9/collabokeys/llms.txt

Use this file to discover all available pages before exploring further.

CollaboKeys is a macOS desktop app that turns a single keyboard into a shared controller for any keyboard-driven game. The host runs the app, shares a link, and every player claims their own keys — no accounts, no installs, just a browser and a local network connection.

Installation

Download the macOS app or build from source with Node.js.

Quickstart

Get a session running in minutes: host setup to first keypress.

Gameplay

Understand how key reservation works and how players collaborate.

Configuration

Tune ports, rate limits, player names, waiting room, and more.

Admin Page

Control your session from any browser with the admin dashboard.

Console Commands

Full reference for every CLI command available on the host.

How CollaboKeys works

1

Host starts CollaboKeys

Open the macOS app (or run npm start from the project directory). The app starts a local Socket.IO server and opens the admin dashboard automatically.
2

Share the server link

Click Show Link in the admin dashboard to reveal your local IP address and port. Send this URL to your players.
3

Players join in their browser

Each player opens the link, enters a username, and starts pressing keys. The first player to press a key claims it — only they can use it going forward.
4

Play any keyboard-driven game

Open your game on the host machine. Every keypress from connected players is emulated directly on the host’s keyboard in real time.
CollaboKeys requires macOS on the host machine. Player clients work in any modern browser on any OS, as long as they are on the same local network as the host.

Build docs developers (and LLMs) love