tldraw/obsidian-plugin

Support live sync/collaboration

Open

#49 opened on Sep 12, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (22 forks)github user discovery
help wanted

Repository metrics

Stars
 (420 stars)
PR merge metrics
 (Avg merge 15h 27m) (6 merged PRs in 30d)

Description

When using obsidian with a sync plugin setup, either official or self-hosted, the underlying markdown file to the tldraw drawing gets synced, but until you close and reopen the selected drawing in the receiving client, the markdown doesn't get re-read.

This means live collaboration doesn't really work using this plugin, as it does on tldraw.com. I'm wondering if there's a way to tap into the collaboration functionality on tldraw.com, or would it require users to create their own sync servers?

Perhaps as a compromise this plugin could listen for changes to the underlying markdown file and tell the tldraw window to re-read it? Would probably require some kind of merge conflict handling.

Contributor guide

Research direction
Explore Obsidian's plugin API for file change detection and integrate with tldraw's internal methods to refresh the drawing on file changes. Also evaluate tldraw's collaboration protocols for potential integration.
Tech stack
typescript
Domain
desktopfrontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60