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 free, open-source macOS app that turns any keyboard-controlled game into a chaotic cooperative experience. The host runs the app on their Mac and shares a link; players join from any browser, claim keys on first press, and together control the game in real time.

Installation

Download the macOS app or build from source in minutes

Quickstart

Get a session running and share it with friends in under 5 minutes

How It Works

Understand the key reservation system and real-time input flow

Admin Controls

Manage players, keys, and the server from any device

What makes CollaboKeys different

Unlike screen-sharing or remote-control software, CollaboKeys gives each player ownership of a unique subset of keys — first come, first served. No single player can control everything. Everyone must communicate and coordinate to play effectively, creating emergent cooperative (or chaotic) gameplay from any ordinary keyboard game.
1

Host starts the app

Download and open CollaboKeys on a Mac. The app starts a local server and opens the admin panel automatically.
2

Share the link

Click Show Link in the admin panel to reveal your local IP address. Share it with anyone on the same Wi-Fi.
3

Players join from a browser

Players navigate to the link, pick a username, and start pressing keys. Each new key they press is reserved exclusively for them.
4

Play any keyboard game together

Open any keyboard-controlled game on the host Mac. Every keypress from players is emulated in real time on the host’s keyboard.

Key features

Real-Time Input

Keypresses are forwarded to the host via Socket.IO and emulated using a native macOS helper — latency is minimal on a local network.

No Install for Players

Players join from any browser on any device — phone, tablet, or laptop. Only the host needs to install CollaboKeys.

First-Come Key Ownership

The first player to press an unclaimed key owns it for the session. Keys are released when a player disconnects or the admin revokes them.

Admin Panel

Control emulation, manage the waiting room, revoke keys, and view live logs from any browser — not just the host machine.

Console Commands

Full CLI control: stop the server, enable/disable emulation, list players, and more — all from the terminal.

Configurable

Adjust ports, key limits, rate limiting, player name rules, waiting room behavior, and more via a single JSON config file.
CollaboKeys requires players to be on the same local network as the host. Cross-network play is not currently supported.

Build docs developers (and LLMs) love