Skip to content

[Feature] KoReader plugin: Add option to skip automatic sync on activation when Wi-Fi is unavailable #471

Description

@adams79

What's your idea?

Add a setting to control whether the KOReader plugin should automatically sync when opening a book (or ideally only sync when WiFi is already connected)

What problem does it solve?

On some e-readers, when opening a book, the BookOrbit KOReader plugin tries to synchronize immediately.

If the device is outside Wi-Fi coverage, or if Wi-Fi is not currently connected, the e-reader can remain blocked or unresponsive for a long time while the sync attempt waits or fails.

This is especially problematic because it happens immediately after opening the book, before the user can comfortably interact with KOReader.

A setting to skip automatic sync when Wi-Fi is unavailable would avoid these long blocking waits and make the plugin safer to use on devices that are often read outside home Wi-Fi coverage.

Anything else? (optional)

I previously solved a similar issue with a local KOReader patch (for the Stock progress sync plugin): sync was executed on book open/device reactivation only if Wi-Fi was already connected. Otherwise, no automatic sync was attempted, and the user could manually trigger synchronization later.

In my setup, I mapped manual sync to a shortcut on the lower-right corner of the screen. This made the workflow very convenient:

  1. Open the book.
  2. If Wi-Fi is already available, sync can happen automatically.
  3. If Wi-Fi is unavailable, KOReader remains responsive.
  4. When Wi-Fi becomes available again, the user can manually trigger sync with the shortcut.

This approach avoids unnecessary blocking network attempts while preserving the current sync functionality.

Want to help?

Yes, I'd like to implement this

Before submitting

  • I've searched existing issues and this hasn't been requested yet.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature request or capability proposal.releasedIssue or PR is included in a released version.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions