@roomful/core

Framework-agnostic core for Roomful — real-time collaboration primitives (presence, cursors, shared state, awareness, events, viewport sync, laser pointer, locks, comments, and history) over WebRTC, BroadcastChannel, or a self-hosted WebSocket relay. Zero backend required for small rooms.

Stable — v1.5. Realtime presence, cursors, and shared state, plus the collaboration primitives (room.useViewport, useLocks, usePointer, useComments, useHistory). The API is stable and ready for production.

Install

npm install @roomful/core

# Optional: CRDT (Yjs) support
npm install yjs y-protocols

Usage

import { createRoom } from '@roomful/core';

const room = createRoom('my-room', {
  presence: { name: 'Alice', color: '#4F46E5' },
});

await room.connect();

const presence = room.usePresence();
presence.subscribe((peers) => {
  console.log(`${peers.length} peers online`);
});

Documentation

See the Roomful repository for the full API reference, guides, and examples — including the v1.5 collaboration primitives: viewport, locks, pointer, comments, and history.

License

MIT