Skip to content
Roomful
v1.0 · open source

Realtime collaboration, documented

Presence, multiplayer cursors, shared state, AI agents, and awareness for any app — over WebRTC, WebSocket, or your own relay, with first-class React, Vue, Svelte, Solid, Angular, and Flutter bindings.

Install Roomful Open the Playground Self-host a Relay
$ npm i @roomful/core

Documentation version: v2.8 — the v2.8 baseline including cloud management, self-host relay, and enterprise deployment.

What is inside

Section titled “What is inside”
  • A getting started flow with copy-pasteable setup, connection, presence, and transport examples.
  • Generated API reference pages for the public @roomful/* packages.
  • Cloud management API docs for projects, rooms, quotas, and usage metering.
  • Self-host deployment guide with Docker Compose and PostgreSQL.
  • A playground you can run locally against broadcast, webrtc, or websocket.
  • Community, contribution, and project process links in one place.

Start here

Install Get the core package running with copy-pasteable setup and a minimal room. API Reference Browse generated package documentation sourced directly from JSDoc. Playground Open two tabs, connect with broadcast, and watch presence plus shared state sync live. Community Find contribution guidance, issues, discussions, and the project standards.