Koreader plugin to sync annotations

[dani84bs]

Hello MobileRead community,

I've been a lurker on these forums for years, and I'm excited to finally make my first post to share a project I've been working on for KOReader.

Like many of you, I use KOReader on multiple devices (my Boox, my phone, and my mac), and I've always wanted a seamless way to keep my reading progress and annotations in sync. While KOReader's progress sync is fantastic, I wanted to take it a step further with highlights and notes.

So, I created AnnotationSync, a plugin that allows you to sync your book annotations (highlights, notes, bookmarks) between your devices using KOReader's native cloud sync functionality.

What does it do?

The goal is to be simple and "just work."

Syncs Annotations: It syncs all your highlights, notes, and bookmarks for a specific book.

Uses Native KOReader Sync: It leverages the cloud storage service you've already configured in KOReader (like Dropbox, FTP, WebDAV, etc.). No need for a separate service or setup.

Manual Trigger: You have full control over when you sync. A new menu item allows you to pull the latest annotations from the cloud or push your local changes up.

How to Install

Go to the GitHub releases page: [Link to your GitHub releases page, e.g., https://github.com/dani84bs/Annotati...ugin/releases]

Download the latest AnnotationSync.koplugin.zip file.

Extract the annotationsync.koplugin folder and copy it to the koreader/plugins/ directory on your e-reader.

Restart KOReader.

This is the first version!

Please consider this an early release (beta). I've tested it on my own devices, but there are bound to be bugs.

IMPORTANT: I highly recommend you back up your koreader/metadata folder before using the plugin for the first time, just to be safe.

Feedback and Contributions

I'm sharing this to get feedback from the community. Please try it out and let me know what you think! Bug reports and feature suggestions are very welcome.

The best place to report issues or suggest new features is on the GitHub issues page.

GitHub Repository (for source code and issues): https://github.com/dani84bs/AnnotationSync.koplugin

Direct Download: [Link to the latest .zip file directly]

A huge thank you to the entire KOReader team for creating such an amazing and extensible reader.

Looking forward to hearing your thoughts!

Best,
dani84bs