Skip to content

Releases: ManorianOTP/Grimmory-KOReader-Client

Grimmory KOReader Client v2.0.0

Choose a tag to compare

@ManorianOTP ManorianOTP released this 12 Aug 23:33

Grimmory KOReader Client v2.0.0

First public Grimmory-native release, published on 12 August 2026. Both plugin
archives are versioned and released together; install both for the complete
client.

Downloads

  • grimmory.koplugin-2.0.0.tar.gz — library browsing, downloads, accounts,
    connection tools, and updates
  • grimmory_sync.koplugin-2.0.0.tar.gz — reading progress, EPUB annotations,
    reading sessions, and shelf collection sync
  • manifest.json — checksums and metadata used by the in-app updater

Do not use GitHub's automatically generated source-code archives as KOReader
plugins. See the installation guide
for clean-install and legacy BookLore replacement instructions.

Highlights

  • Renamed the two plugins and their settings, caches, queues, updater staging,
    artifacts, and user agents to Grimmory conventions.
  • Added canonical Grimmory Book/BookFile normalization, paginated library
    traversal, corrected sorting and filtering, exact primary/alternative file
    selection, and downloads.
  • Moved progress to Grimmory's App progress API and selected-file identity, with
    EPUB XPointer/CFI conversion, exact PDF/CBX pages, and percentage-based
    FB2/MOBI/AZW3 progress.
  • Added opt-in conflict-safe EPUB highlight/note sync, durable reading-session
    sync, and additive shelf mirroring into scoped KOReader collections.
  • Added the Connection & Sync panel with explicit connection attempts, sync
    settings, device/server positions, and a pending-book badge.
  • Made queued progress account-, server-, book-, and file-aware; background
    bulk sync pulls before pushing so newer server progress remains a conflict.
  • Hardened downloads, logging, Tailscale installation, and the paired-plugin
    updater with checksums, safe archive validation, backups, rollback, and
    interruption recovery.
  • Added locked and pinned CI dependencies plus Lua, JavaScript, Python, visual,
    packaging, release-validation, and real-device/real-server acceptance gates.
  • Replaced external service artwork with original generic icons and documented
    security, contribution, provenance, compatibility, and privacy boundaries.

The tested reproducibility baseline is Grimmory v3.3.1. Newer Grimmory releases
may work, but should be validated against the compatibility suite before being
declared supported.

This is intentionally a clean install. Historical v1.0.0 BookLore plugin data
and settings are not migrated in place.

For the complete itemized history, see the changelog.

v1.0.0

Choose a tag to compare

@ManorianOTP ManorianOTP released this 15 Jun 04:34

Changelog

All notable changes to BookLore KOReader Client are documented here. This
project follows Semantic Versioning. Both plugins
(booklore.koplugin and booklore_sync.koplugin) share a single version per
release.

1.0.0 - 2026-06-15

Initial public release: a pair of KOReader plugins that turn a jailbroken Kindle
into a client for a self-hosted BookLore
server.

booklore.koplugin

  • Log in to a BookLore server (URL plus username/password) with multi-account
    support and silent access-token refresh.
  • Browse, search, sort (19 options), and filter (14 dimensions with live facet
    counts) your library; covers are cached and versioned.
  • Rich book-detail pages mirroring the BookLore web UI (blurb, genres, rating,
    series) and tuned for E Ink.
  • Download books with a live, cancellable progress bar; opened books are matched
    back to their BookLore record for progress sync.
  • Works offline: the last library view is cached and actions are queued, then
    flushed when you are back online.
  • Settings menu: account status and switcher, download-folder editor, sign out,
    and a clean uninstall (optionally keeping saved settings for an easy reinstall).
  • Tailscale onboarding (install, connect, status, update) to reach a server that
    is not on your local network.
  • In-app self-updater — BookLore ▸ Check for updates downloads, verifies
    (sha256), and swaps both plugins from a GitHub release, with crash-safe staging
    and boot-time reconciliation.

booklore_sync.koplugin

  • Bidirectional reading-progress sync with BookLore via the kosync protocol,
    translating between KOReader XPointer and BookLore CFI positions.
  • Push is gated on the initial pull so opening a book never overwrites the
    server; a prompt appears when the server is ahead of the device.
  • Offline progress queue that flushes once connectivity returns.