Skip to content
Roomful
Roomful is in public beta — install with the @beta tag. Share feedback →
Public beta · open source

Realtime collaboration, documented

Presence, multiplayer cursors, shared state, and awareness for any app — over WebRTC, BroadcastChannel, or your own relay, with first-class React, Vue, and Svelte bindings.

Install Roomful Open the Playground
$ npm i @roomful/core@beta

Documentation version: v1.0 — the v1.0 baseline of the Roomful documentation.

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.
  • 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.