Roomful is in public beta — install with the @beta tag. Share feedback →

Installation

Audience: users.

Requirements

Browser runtime

Chrome/Chromium 80+
Firefox 75+
Safari 14+
Edge 80+

Tooling

Node.js 18+
npm or pnpm

Packages

Install only what you need.

# Core SDK (required)
npm install @roomful/core@beta

# CRDT / Yjs support (required only when using strategy: 'crdt' or Yjs APIs)
npm install yjs y-protocols

# Framework adapters (optional)
npm install @roomful/react@beta
npm install @roomful/vue@beta
npm install @roomful/svelte@beta

# Prebuilt collaboration UI (optional)
npm install @roomful/cursors@beta

# Self-hosted relay server (optional)
npm install @roomful/relay@beta

# Relay CLI (optional)
npm install -g @roomful/relay@beta

Environment Constraints

WebRTC-based collaboration depends on browser support and network policy.
Cross-network sessions need STUN/TURN configuration for production.
SSR/Node environments can document configuration but cannot run browser WebRTC transport directly.

CRDT Dependency Note

@roomful/core declares yjs and y-protocols as peer dependencies.
Install them when you use room.getYDoc(), room.getYProvider(), or useState({ strategy: 'crdt' }).
If you only use lww or custom state strategies, no extra CRDT packages are needed beyond the base install.

Versioning Note

The project is pre-v1.0. Verify package versions and release notes before adopting APIs in production.