🔗What to Sync

Found at: Tools → BookLore Sync → What to Sync

This menu contains four sections: Reading Sessions, Progress Sync, Rating Sync, and Annotations & Bookmarks.

🔗Reading Sessions

🔗Detection Mode

Options: Duration-based (default) | Pages-based

Controls which threshold is used to decide whether a reading session is valid and worth uploading.

Only one mode is active at a time.

🔗Minimum Duration

Default: 30 seconds

Sessions shorter than this are discarded without being saved or uploaded. Prevents accidental micro-sessions (e.g. opening a book to check a page number) from appearing in your reading history.

Only active when Detection Mode is set to Duration-based.

🔗Minimum Pages

Default: 5 pages

Sessions where fewer pages were read than this value are discarded. Useful for formats where short time can still represent real progress (e.g. picture books, comics).

Only active when Detection Mode is set to Pages-based.

🔗Progress Decimal Places

Default: 2  |  Range: 0 – 5

Controls how many decimal places are included in the progress percentage sent to the server at sync time. The full precision value is always stored in the local database; this setting only limits what is transmitted.

🔗Rating Sync

Requires BookLore account credentials to be configured. See Authentication.

🔗Enable rating sync

Toggle on to push ratings to BookLore at the end of a reading session.

🔗KOReader rating (scaled ×2)

KOReader uses a 1–5 star scale. BookLore uses a 1–10 scale. When this mode is selected the plugin multiplies the KOReader star rating by 2 before sending it.

The rating is read from the summary.rating field of KOReader's DocSettings. When syncing at book-close time, the live in-memory DocSettings object is used directly. In all other cases (e.g. deferred sync of pending sessions), the .sdr sidecar file on disk is read as a fallback. If no rating has been set in KOReader, no rating is synced.

🔗Select at complete

A 1–10 rating dialog is shown when you close a book that has reached 99% or more progress. Your selection is immediately synced to BookLore. Closing the dialog without selecting skips the rating for that session.

To prevent some bugs, the dialog is shown with a ~2s delay and does not open the keyboard.

🔗Hardcover rating sync

Toggle on to also sync the rating to your Hardcover account when a session ends. Uses the Hardcover book ID stored in Booklore for the matched book.

Requires Enable rating sync to be on. Hardcover account setup (API token and book ID fetch) is covered in Hardcover.

🔗Annotations & Bookmarks

Note: In-book EPUB CFI annotation positioning is only supported for EPUB files. For PDF files, a mock CFI placeholder is used. Annotation sync is not supported for CBZ/CBR formats.

Requires BookLore account credentials to be configured. See Authentication.

🔗Sync highlights and notes

Toggle on to upload KOReader highlights and notes to BookLore at the end of qualifying reading sessions.

The plugin tracks uploaded annotations in a deduplication table so the same highlight is never uploaded twice.

🔗Sync bookmarks

Toggle on to also upload KOReader position bookmarks (markers without selected text) to BookLore.

Bookmarks are deduplicated via the synced_bookmarks table and uploaded to POST /api/v1/bookmarks.

🔗Notes destination

🔗Upload strategy

Note: When Sync Behavior is set to Manual only (cache everything), annotations are always cached locally regardless of this setting. They will only upload when you manually trigger a sync via Sync & Cache → Sync Pending Now or the SyncBooklorePending dispatcher action.

🔗Highlight colours

KOReader named colours are mapped to BookLore hex values:

🔗Related: Sync Behavior

Sync mode and upload timing are configured separately in:

Tools → BookLore Sync → Sync Behavior

See Sync Behavior in the settings menu for:

• Automatic / Manual / Custom mode
• Auto-sync on suspend
• Connect WiFi on suspend
• Ask to enable WiFi