CalibReader / Support / Calibre plugin

The CalibReader desktop plugin

A small Calibre plugin, CalibReader Sync, that brings your phone's read/unread marks back into your desktop library.

Download CalibReaderSync.zip Latest release · Calibre 5.0+ · release notes

Install the plugin

  1. Download CalibReaderSync.zip from GitHub Releases (button above).
  2. In Calibre, open Preferences → Plugins.
  3. Click Load plugin from file and select CalibReaderSync.zip.
  4. Restart Calibre. Optionally add the Sync Read Status button to your toolbar.
image pending: d-plugin-install

Configure it

The plugin has no settings dialog. It needs one thing in place before it can run: a Yes/No custom column with the lookup name read_status.

  1. Create the column in Preferences → Add your own columns: lookup name read_status, type Yes/No, heading Read Status. See Custom columns for the full walkthrough.
  2. Make sure your Calibre library folder is the same cloud-synced folder CalibReader reads on your phone. The plugin looks for CalibReader_sync.json right inside that library folder.
  3. Wait for your cloud client (Dropbox, OneDrive, or Google Drive) to finish syncing so the latest CalibReader_sync.json has landed, then run the plugin from the toolbar or menu with Sync Read Status.
image pending: d-plugin-config

What it does

When you click Sync Read Status, the plugin reads CalibReader_sync.json from your Calibre library folder and, for every book whose UUID appears in that file, sets the #read_status column to read or unread, so the books you finished on your phone show as read on the desktop. Books in the file that don't match a UUID in the current library are skipped.

The plugin reads; CalibReader on your phone writes the read marks. See Set up sync to point both at the same cloud folder.