Xteink Sync — send notes to an Xteink X3/X4 e-reader as EPUB

MUST READ - FAILURE TO FOLLOW THE RULES WILL LEAD TO A BAN

Please, remember that the main purpose of this forum is to help Obsidian users. This goal should not be abused to advertise third-party projects.

General Rules:

  1. We will only accept Obsidian plugins present in the community directory.
  2. Keep posting all the future updates of your plugin in this one thread.
  3. Fill the disclaimer below and leave it on top

NOTES:

  • If you project tackles one of the open feature requests, you can post a SHORT message in related FR topic with a link to this thread (your project thread). This is done to avoid hijacking other threads into a collection of bug reports and feature requests for your plugin.

  • If you can’t add links because your account is new, use inline code, e.g. https://google.com.

Once you are done reading, please delete this note

Disclaimer

Is this plugin open source? Yes/No
Is this plugin completely free? Yes/No
Is this plugin vibe-coded beyond the author’s ability to comprehend how it works? Yes/No
Community Directory: [Link](https://community.obsidian.md/xyz)


Disclaimer

Is this plugin open source? Yes — MIT licensed
Is this plugin completely free? Yes. No account needed for Wi-Fi mode; the optional online shelf is also free (or self-host it)
Is this plugin vibe-coded beyond the author’s ability to comprehend how it works? Partly — written with heavy AI assistance. I know what it does and where the data goes (see “Privacy / network”), but I’m not an expert in every line. It has unit tests, and issues/PRs are welcome.
Community Directory: https://community.obsidian.md/plugins/xteink-sync
Source: GitHub - ptk862010/obsidian-xteink-sync: Gửi và đồng bộ note Obsidian sang máy đọc sách Xteink (CrossPoint) dạng EPUB, qua WiFi · GitHub

Hi everyone,

I read on a small Xteink X4 e-ink reader running the open-source CrossPoint firmware. I wanted my notes and clipped articles on it, but the usual route (export → convert with pandoc or Calibre → copy over USB) was too much friction for something I do every day.

So I built Xteink Sync: it turns notes into EPUB inside Obsidian and sends them to the reader. No pandoc, no desktop app, and it works on mobile too.

Two destinations

  • Reader on Wi-Fi — pushes the EPUB straight into the reader when it’s in File Transfer → Join Network on the same network.
  • Xteink Lover shelf — uploads to a free online shelf; the reader downloads it over OPDS whenever it’s online. Works from anywhere, even when the reader is off. You can also self-host the shelf on Cloudflare’s free plan.

What it does

  • Send by hand: right-click a note or folder → Send to Xteink. If the reader isn’t reachable, EPUBs wait in a queue.
  • One-click sync: sends new and changed notes from the folders and tag you choose. Optionally removes files for notes that left the sync scope (only files this plugin sent).
  • Auto-send new notes: watches a folder (default Clippings, where Obsidian Web Clipper saves). Clip an article in your browser → it’s on your reader a few seconds later.
  • Uses Obsidian’s own renderer, so callouts, tables, embeds and links look like reading view.
  • Scales images for e-ink and re-encodes them as baseline JPEG (CrossPoint can’t show progressive JPEG or GIF).
  • Mermaid and math are kept as source text; footnotes stay clickable.
  • Connect reader: saves the shelf’s OPDS server on the reader over Wi-Fi, so you don’t have to type on the device.
  • English and Vietnamese interfaces.

Privacy / network

Network requests only happen when you send, sync, or press Check. Wi-Fi mode talks only to the reader on your local network. Shelf mode uploads EPUBs to the server you set, with a revocable app token. Remote images are not downloaded unless you turn that on. No telemetry, no analytics.

Requirements

An Xteink X3/X4 with CrossPoint firmware (tested with 1.6). The stock firmware has no OPDS and no upload API.

Feedback, bug reports and feature ideas are very welcome — here or on GitHub. If you have a different CrossPoint device, I’d love to hear whether it works.