AnnotationSync.koplugin

Sync your KOReader annotations everywhere!

Never lose a highlight or note again—AnnotationSync keeps your reading life in sync across all your devices.

🚀 Features

• Cloud sync for KOReader annotations (highlights, notes, bookmarks)
• Manual sync & remote backup for peace of mind
• Easy access from KOReader's main menu
• Configurable cloud server settings
• Smart merging: resolves annotation conflicts by update time
• Detects and marks deleted annotations
• Supports multiple annotation formats & metadata
• Lightweight, minimal setup—just enable and configure!

📦 Installation

1. Copy this folder to your KOReader plugins directory (make sure it is named AnnotationSync.koplugin)
2. Restart KOReader.
3. Enable AnnotationSync from the plugins menu.

🛠 Usage

• Open KOReader and activate AnnotationSync from the plugins menu:

  • Tools -> More tools -> Plugin management

• Choose the cloud storage source in Annotation Sync settings:

  • Tools -> Annotation Sync -> Settings
  • Add a cloud storage service, if necessary:
    • Add service -> +
    • Supported providers: Dropbox, FTP, WebDAV
  • Select the desired cloud storage service from the list
  • Restart KOReader as indicated after selection

• Sync your annotations at any time:

  • Use the menu: Tools -> Annotation Sync -> Manual Sync
  • Or bind the "Annotation Sync: Manual Sync" action to a gesture or keyboard shortcut
  • Or add the "Annotation Sync: Manual Sync" action to a profile action list

📦 DropBox setup

Setting up Dropbox on Koreader can be a little bit difficult. This excellent post on mobileread forum explains the procedure in detail.

Details

AnnotationSync stores its files directly in the selected cloud storage directory, so you may want to create a new directory dedicated to AnnotationSync. By using the default settings (i.e. "Use filename instead of hash" unchecked) the sync files are named according to a hash of the document being synced, so it will look something like this:

.
..
330209864aecdf8cc63a16022f6a30f8.json
dda324e17e50f6c8c4c481ee4fcb1aa4.json

There is currently no other identifying information about the original document name stored in either the filesystem or the contents of the files.

If you prefer to use the filename instead of an hash of the content just check the box under: Tools -> AnnotationSync -> Settings -> Use filename instead of hash By doing so the filename on every device should be the same. This option should be chosen by users that change file metadata (e.g. with Calibre) otherwise the hash would change everytime you make any modification.

🤝 Contributing

Pull requests, feature suggestions, and bug reports are very welcome! Open an issue or submit a PR.

📄 Known Issues

• Can't synchronize pdf higlights due to their different data structure. Fixed
• Binding the "Annotation Sync: Manual Sync" action to a profile with "Auto-execute -> on book closing" will cause KOReader to crash. Fixed

---

AnnotationSync.koplugin: Your reading notes, highlights, and bookmarks—always with you, always safe.