A homepage for my KOReader-related plugins and user patches.
Syncest (syncest.koplugin)
Platforms: Multi-platform
Syncest syncs KOReader reading data to a WebDAV folder you control.
It can sync reading progress, annotations, reading stats, vocabulary, and an optional book library across multiple KOReader devices. The goal is to keep your reading data in your own storage instead of tying it to a single device or service.
Bluetooth Configurator (bluetoothconfigurator.koplugin)
Platforms: Android only
Bluetooth Configurator makes it easier to map Bluetooth page turners, controllers, remotes, and hardware keyboards to KOReader actions on Android.
Instead of manually editing KOReader keymapping files, you can press a button, pick an action, and save the binding from inside KOReader. It supports separate bindings for the reader and file manager.
Rotator (rotator.koplugin)
Platforms: Android only
Rotator controls Android's system-wide screen rotation from KOReader. It can toggle autorotate, lock the current orientation, cycle orientations, or rotate 90, 180, or 270 degrees relative to the current position.
Every operation can be assigned to KOReader gestures and actions. Brief lock/unlock indicators confirm changes without covering the center of the screen. Rotator requires Android's one-time Modify system settings permission, but does not require root or ADB during normal use. Other Android systems may behave differently.
Use Rotator directly from Tools → Rotator to toggle autorotate, cycle the screen, or rotate it by 90, 180, or 270 degrees. Rotator also registers each operation with KOReader's Dispatcher, so the same actions can be assigned to gestures, hardware buttons, profiles, or anything else that uses KOReader's action picker.
Thematic (thematic.koplugin)
Platforms: Android verified; other platforms unverified
Thematic adds independent color themes for KOReader's interface and reader content, with separate selections for day and night mode. It includes built-in light and dark palettes and lets you create, duplicate, edit, and delete custom themes entirely inside KOReader.
The plugin also integrates with Zen UI to theme its home screen, navigation tabs, menus, dialogs, buttons, status surfaces, tap feedback, and library cover borders. Thematic can be disabled at any time to restore KOReader and Zen UI's stock rendering without modifying either application's files or saved appearance settings. Enable, disable, and toggle actions can be assigned to KOReader gestures, profiles, or other action shortcuts.
KOBoard (koboard.koplugin)
Platforms: Android only
KOBoard replaces KOReader's built-in virtual keyboard with the Android system keyboard.
This lets you use your normal Android keyboard app for KOReader text input, including keyboards like Gboard, Samsung Keyboard, and Heliboard. It is Android-only and experimental.
Moments of Zen (momentsofzen.koplugin) — Deprecated
Platforms: Multi-platform
Deprecated: This functionality is built into Zen UI 3.0 Beta 2 and later. Use Zen UI's built-in Quotes widget instead.
Moments of Zen adds a quote widget to the Zen UI Home page.
It can show custom quotes, highlights from your KOReader annotations, or a mix of both. Quotes use persistent shuffled decks to avoid repeats, annotation quotes can open their highlighted location in the book, and the widget supports swipe navigation plus automatic or fixed font sizing.
Platforms: Android 9 and later; tested on Samsung Galaxy Z Fold 8
Lets KOReader use the entire screen on phones and tablets with a camera cutout, notch, or punch-hole camera. KOReader normally excludes the cutout's safe inset, which can leave a full-width unused strip along the top of the display.
The patch enables Android's display-cutout layout mode and sizes KOReader's
framebuffer to the complete drawing surface. It uses the early 1- patch prefix
because the corrected dimensions must be available before KOReader creates its
framebuffer.
Install it as:
1-fullscreen.lua
Platforms: Samsung Galaxy Z Fold 8 (SM-F971U1)
Allows KOReader to rotate between all four orientations on the Fold 8's inner display. Without the patch, KOReader's orientation request is interpreted as sensor-landscape on the landscape-native unfolded display, so Android rejects portrait rotations even when system Auto rotate is enabled.
The patch adds an Auto rotate (all orientations) choice to KOReader's rotation menu. Auto mode defers to Android's full orientation sensor, while choosing one of KOReader's normal rotation angles disables auto mode and locks the display to that selection.
It also keeps text and UI elements at the same physical size when switching between the cover and inner displays. The unfolded screen still gains the full additional layout area, without KOReader enlarging everything to match its greater pixel dimensions.
Install it as:
2-fold-8-fix.lua
Adds a breadcrumb row to KOReader's nested top menus so the current menu hierarchy remains visible. Long paths are left-truncated to preserve the most specific entries. Tap a breadcrumb to return directly to that submenu, or long-press one to show the complete path.
Based on koreader-menu-breadcrumbs by Khady.
Changes from the original:
- Each breadcrumb is navigable: tap one to return directly to that submenu.
- Long-pressing the breadcrumb row shows the complete path.
- The row uses a transparent background so it does not cover the menu separator.
- Direct jumps update the menu stack first and rebuild only the destination, avoiding a redraw for every intermediate level.
- Breadcrumb segment widths are measured only when the row is tapped, keeping normal submenu navigation responsive.
Install it as:
2-menu-breadcrumbs.lua
A KOReader user patch that adds a UI font picker to the file manager and reader settings menus.
It lets you choose the font used by KOReader's interface, saves the selected font, updates KOReader's UI font map, and prompts for a restart so the change applies cleanly.
Original patch by sebdelsol.
Changes from the original:
- Uses crengine's discovered font faces directly instead of requiring their
paths to also match KOReader's separate
FontListscan. This prevents valid fonts from disappearing on devices where the two path sources differ, including some Android and Boox setups. - Asks crengine for each font's actual bold face instead of guessing it by
changing
-Regularto-Boldin the filename. If no bold face is available, it safely falls back to the regular face.
Install it as:
2--ui-font_enhanced.lua
A KOReader user patch that adds archive actions to the book menus and end-of-book popup.
How it works:
- Move to archive appears in the long-press book menu in History (library), Collections, file search, and File Manager views.
- The first time you use it, the patch asks you to select an archive folder.
- Moving a book closes the long-press menu and immediately refreshes the active view, so the old entry does not remain visible.
- Inside the configured archive folder, the action becomes Move to library. Books are returned to the folder they came from. If the patch has no saved original folder for a book, it uses KOReader's HOME folder.
- The end-of-book popup gains Mark as complete and archive. This marks the book as complete, moves it and its sidecar data to the configured archive folder, closes the reader, and returns to the folder the book came from.
The archive folder and original-folder mappings are stored in
settings/move_to_archive_settings.lua.
Install it as:
2-move-to-archive.lua
Adds a Bonus gestures section to KOReader's Gesture Manager with fourteen additional assignable gestures. They appear in this order:
- Tap
- Center / center
- Long-press
- Top center
- Center left
- Center / center
- Center right
- Bottom center
- One-finger swipe
- Top to center
- Center to top
- Bottom to center
- Center to bottom
- Two-finger swipe
- Top to center
- Center to top
- Bottom to center
- Center to bottom
Each gesture can have different actions in the Reader and File Manager, just like KOReader's built-in gestures. The swipe gestures check both their starting zone and endpoint, allowing the two-finger variants to remain distinct from the normal full-screen two-finger swipe up and down gestures.
Note: Custom gestures may overlap with existing KOReader actions in the same screen area. For example, assigning an action to Long-press → Center / center in the Reader will take priority over the normal long-press used to select and highlight text in that center zone.
Inspired by the r/KOReader post “Bunch of custom gestures”.
Install it as:
2-bonus-gestures.lua
Adds Search actions to KOReader's dispatcher menus, including the action chooser in Gesture Manager.
Search is case-insensitive and includes actions registered by plugins as well as device-specific actions. Results replace the category list inside the existing dispatcher menu, show their original category, and retain the normal checkbox and configuration behavior. Use the menu's up arrow to return to the category list.
Install it as:
2-action-finder.lua