Jazz

Real-time collaborative desktop sync for Open Web Desktop using Jazz.

Overview

This module provides real-time collaborative state synchronization for Open Web Desktop windows, volume, and desktop configuration using Jazz.

Demo · Documentation · Support

Installation

pnpm desktop add module-jazz

Configuration

Add the module to your desktop.config.ts:

export default defineDesktopConfig({
  modules: [
    '@owdproject/module-persistence',
    '@owdproject/module-jazz'
  ],
  jazz: {
    // If true, stores the active room ID in localStorage to automatically reconnect on reload
    persistRoom: true,
    
    // If true, falls back to a shared public room lobby when no room ID is in the URL
    usePublicLobby: true,
    
    // Custom default room ID (takes precedence over the public lobby fallback)
    defaultRoomId: 'co_...',
    
    // Mesh peer URL
    meshPeer: 'wss://mesh.jazz.tools'
  }
})

License

This application is released under the MIT License.