🔗Dispatcher Actions
The plugin registers seven actions with KOReader's dispatcher system. These can be assigned to hardware buttons, touch gestures, or KOReader profiles.
🔗Available actions
| Action name | Dispatcher key | Description |
|---|---|---|
| Toggle BookLore Sync | ToggleBookloreSync | Enables or disables the plugin. When disabled, no sessions are tracked. Toggle again to re-enable. |
| Sync Pending Sessions | SyncBooklorePending | Triggers an immediate upload of all pending sessions, ratings, annotations, bookmarks, and progress updates in the local queue. |
| Toggle Manual Sync Only | ToggleBookloreManualSyncOnly | Switches between Automatic mode (background sync enabled) and Manual only (cache everything) mode (queue only until manual sync). |
| Test Connection | TestBookloreConnection | Runs a connection test and shows the result as a notification. Equivalent to tapping Test Connection in the Settings menu. |
| Sync Shelf | booklore_sync_shelf | Triggers an immediate shelf sync - downloads new books from the configured BookLore shelf and optionally removes books no longer on the shelf. |
| Pull Current Book Progress | PullBookloreCurrentBookProgress | Pulls remote progress for the currently open book and applies it using the configured forward/backward conflict strategies. |
| Push Current Book Progress | PushBookloreCurrentBookProgress | Queues and uploads progress for the currently open book immediately. |
🔗Assigning an action
To assign an action to a gesture or button in KOReader:
- Go to Tools → More tools → Gestures (or the equivalent for your device).
- Select the gesture or button you want to configure.
- Choose Other actions from the action list.
- Scroll to find the BookLore Sync actions and select one.
- Confirm.
The exact navigation path varies by device and KOReader version. Consult the KOReader documentation for your specific device if needed.
🔗Use cases
Sync Pending Sessions (SyncBooklorePending) is the most commonly assigned action. Assigning it to a swipe gesture lets you sync your queued reading data (sessions, annotations, ratings, bookmarks, and progress updates) with a single gesture without navigating any menus.
Toggle BookLore Sync (ToggleBookloreSync) is useful if you read some books that are not in your BookLore library (e.g., work documents, temporary files) and you want to quickly disable tracking without going into the Settings menu.
Toggle Manual Sync Only (ToggleBookloreManualSyncOnly) is useful on metered or unreliable connections - you can switch to manual mode when on mobile data and back to automatic mode when on Wi-Fi.