Skip to content

Automattic/vip-real-time-collaboration

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VIP Real-Time Collaboration

VIP Real-Time Collaboration (VIP RTC) enables multiple users to edit the same WordPress content simultaneously, using the Block Editor. Team members can collaborate on Posts, Pages, and Custom Post Types with near-instant updates, seeing each other's changes as they type and configure content.

Table of Contents

Features

  • Real-Time Collaboration: Multiple users can edit content simultaneously with instant updates
  • Smart Conflict Resolution: Automatically merges changes to help prevent overwriting each other's work
  • Visual Collaboration Indicators: See live cursors, user avatars, and editing activity from team members
  • Reliable Connection Management: Graceful handling of network interruptions with automatic reconnection

Supported content types

Out of the box, the plugin works with all WordPress posts and pages, including Custom Post Types.

Requirements

  • WordPress: 6.7 or newer
  • Gutenberg: This plugin currently requires a custom Gutenberg build (latest release)
  • WebSocket server: A WebSocket server facilitates real-time communication between peers. The code is included in this repo but must be deployed separately.

See CONTRIBUTING.md for development setup instructions.

FAQ

Do I need special permissions to collaborate?

No additional permissions are required. Users can collaborate on any content they already have permission to edit in WordPress.

What happens if my internet connection drops?

The plugin handles brief connection interruptions gracefully. If the connection becomes particularly unstable, your editing session will be paused.

How does conflict resolution work?

The plugin uses a CRDT to automatically merge changes from multiple users and prevent conflicts.

Development

For development setup, contributing guidelines, and technical information, please see:

Credits

Parts of this work are derived from contributions made by Kevin Jahns in this PR.

About

A real-time collaboration WordPress plugin made by WPVIP

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 9