KOReader Patches
KOReader patches fine-tune the interface, browser, screensaver, and Project: Title styling. Apply only what you need and restart KOReader after every change.
DISCLAIMER: These user patches are community-created. Download and use at your own risk. Please read each patch's GitHub instructions and README to understand what it does. See the KOReader User Patches documentation for installation details.
Installation
- Create a
patchesfolder inside your KOReader directory (skip if it already exists). - Download each user patch and copy the
.luafile into/koreader/patches/without renaming it. - Restart KOReader so the new patch loads.
Core Reading Patches
Essential patches for improving the reading experience.
- 2-browser-folder-cover.lua - Add cover art to mosaic folders with optional custom
.coverimages and layout toggles under Settings → Mosaic & detailed list. - 2-browser-hide-underline.lua - Hide the "last visited" underline; enable the toggle in Settings → Mosaic & detailed list.
- 2-browser-up-folder.lua - Move the "up folder" control into the title bar and optionally hide empty folders.
- 2-filemanager-titlebar.lua - Add rearrangeable metadata widgets to the file manager title bar.
- Book Receipt - Display detailed book statistics and reading metadata on-screen
UI Customization
Patches for customizing the KOReader interface and menus.
- 2--ui-font.lua - Switch the KOReader UI font via Settings → UI font.
- 2-menu-size.lua - Reflow menu dimensions to match your device DPI for nicer touch targets.
- 2-disable-top-menu-zones.lua - Disable the swipe/tap hotzones so the top menu always reopens on its last tab.
- Info Message when Opening File Manager - Display helpful notifications when accessing files
- 2-BrowseByMetadata.lua - Adds author, title, series, and keyword browser views.
- 2-browser-double-tap.lua - Require double-tap to open books in the file browser, preventing accidental single-tap opens.
- 2-browser-frontlight-update.lua - Update Project: Title/Cover Browser frontlight widget in real time when frontlight is adjusted.
- 2-automatic-book-series.lua - Automatically group books in the same series into virtual folders within the File Browser.
- Swipe Animation - Software page-turn animation (wipe/erase effect) as a patch
- Fancy Highlight Styles - Adds 8 new highlight and underline styles
- Menu Breadcrumbs - Menu breadcrumbs with a full-path popup
- Calibre Page Estimate - Page-count estimate for unopened books using Calibre data
- Fonts Menu Link - Adds a fonts menu link to the character panel (single patch file)
Status Bar & Visual Tweaks
Patches for customizing the status bar, colors, and visual appearance.
- 2-statusbar-better-compact.lua - Improve compact mode icons, separators, and title/author labels.
- 2-statusbar-cycle-presets.lua - Tap the status bar to cycle through saved preset layouts (requires KOReader v2025.04.52+).
- 2-statusbar-thin-chapter.lua - Add level-1 TOC chapter markers to the thin progress bar.
- 2-reference-page-count.lua - Fix reference page fallback logic so page counts stay accurate.
- 2-change-status-bar-color.lua - Change status bar read/unread colors under Status bar → Progress bar → Thickness, height & colors.
- Change Status Bar Color - Customize status bar colors for color e-reader displays
- Justify Status Bar - Align status bar content with proper spacing and justification
- 2-reader-header-print-edition.lua - Impacts the page header / footer layout when reading a book.
- Color Themes - Day/night reading themes with a curated, customizable palette
- Kindle-Style UI - Kindle-inspired footer with chapter time and a centred clock header
Screen & Sleep Customization
Patches for screensaver behavior and sleep screen messages.
- 2-screensaver-chapter.lua - Add
%Cchapter title and%Ppercent tokens to the sleep screen message. - 2-screensaver-cover.lua - Center images, refresh before sleep, and tweak night mode behavior for sleep screens.
- Redesigned Banner Sleep Screen - Visual refresh of the default banner-style sleep screen with enhanced layout and additional data field.
- 2-redacted-screensaver.lua - Show the current page with random words covered by black redaction bars as a sleep screen.
Advanced Features
Standalone patches for extending functionality.
- Increase Font List - Expand available fonts by adding custom typeface options. Note: Read through the entire issue thread to locate the code snippet, copy it into a text editor, save the file with a
.luaextension (e.g.,2-increase-font-list.lua), then place it in your patches folder. - Unified Auto Sync - Enable automatic synchronization of reading progress across devices
- 2-update-patches.lua - In-app updater for the sebdelsol patch collection (requires KOReader v2025.04.107+).
- KinAMP KOReader Integration - Launch KinAMP music player from KOReader's Tools menu with basic integration.
- Cloudflare Auth - Access OPDS libraries protected by Cloudflare authentication
Community Patch Collections
Curated patch collections from community developers. Each repository contains multiple patches organized by function—explore the full collection on GitHub for patches matching your setup.
- sebdelsol – Curated the patch library and original documentation
- angelsangita Assorted User Patches - Community collection with browser and UI enhancements
- medinauta Patches - UI enhancements including Book Spine Effect and Rounded Corners
- joshuacant Assorted User Patches - Comprehensive collection including Project: Title patches
- Djeymisson Assorted User Patches - Focused patches for cover browser customization
- zenixlabs Frankenpatches - Experimental and advanced patches for power users
- VeeBui's Detailed Header Footer Patches - Enhanced header and footer customization options
- clarainna Download Buttons - Add download indicators and management buttons to your browser
- Minimal Book Stats - Lightweight version of book receipt showing essential statistics
- Reader Header Alternative - Streamlined page header design for reading view
- Smart Collections - Organize books by custom collections and tags
- timault KOReader Patch - Visual UI overhaul with spine shadows and smart collections
- KukkiiNeko User Patches Collection - Community collection with assorted UI and behavior tweaks
- gennaro-tedesco KOReader.patches - Patch set including font normalizers and weather lockscreen tweaks
- Stacked Top or Bottom Bars - Reposition and reorganize interface bars for different layouts
- sparklerfish Patches - Browser double-tap, frontlight widget updates, and redacted screensaver
- xusoo Patches - Automatic book series grouping in virtual folders
- qewer33 Patches - Custom navbar and title bar, hide pagination, and quick settings
- quanganhdo User Patches - Author/series display, finished badge, reading stats and insights popups, metadata tabs in the file manager
- jmanteau Patches - Visual overhaul, browser double-tap, and a switch to disable all cover browser widgets
- Euphoriyy Patches - Percent badges, rounded covers for SimpleUI, screen border and refresh dimming fixes, document inversion, custom pan rate
- ImSoRight Patches - Star rating overlay, custom highlight colors, completed-status icon, and larger subtitles
- Craftwork2720 Patches - Exclude folders, incognito mode, hide the status bar, physical page count, and file manager title tweaks
- peterboda236 Patches - Frontlight widget with profiles and night mode, plus reading time in the table of contents
- chiahsien Patches - Sort by author or series, folder covers, and cleanup of orphaned .sdr folders
- koboprincess Patches - Book cover navbar, page/percent badges, stacked rounded folder covers, and highlight menu edits
- de3sw2aq1 Patches - Browse by metadata, auto collections from folder paths, minimal progress bar, random sort, and search by author
- brugsbells Patches - Series badge, uniform cover size, and disable Wi-Fi notifications
- reuerendo Patches - Book load cover, keep previous screen, and PocketBook-native dialogs
Project: Title — User Patches
User patches crafted specifically for Project: Title. Download manually—these are not bundled with the plugin.
- 2-disable-unread-progressbars.lua - Hide unread progress bars in Cover Grid for cleaner cards.
- 2-menutext-overrides.lua - Rename folders/files for display by replacing underscores and reordering leading articles.
- 2-project-title-jpeg-filter.lua - Filter
.jpg/.jpegfiles from Library mode to keep grids focused on books. - 2-progress-bar-colors.lua - Recolor progress bars on color displays to match Project: Title palettes.
Project: Title — Developer Collections
Comprehensive patch repositories from Project: Title enthusiasts with themed customizations and UI variations.
- loeffner Project Title Patches - Advanced styling patches tailored for Project: Title grid layouts
- crasmoisi PT Assorted Patches - Thematic customizations and header/footer variations for Project: Title
- Project Title Alternative - Alternative Project: Title styling with different visual themes
Project: Title — Grid & Cover Enhancements
- Centered Arrows in Footer - Center navigation arrows in footer area for balanced layout
- Page Count Instead of Progress Bar When Unopened - Display page count on unread books in Cover Grid view
- Page Count When New or Finished - Show page totals for unstarted and completed books in Cover List view
Project: Title — Compatible Extras
General patches verified to cooperate with Project: Title while extending library features. Pair them with the browser tweaks above for a full themed shelf.
- KOReader Page Header - Fiction-style header bar with per-book configuration that matches Project: Title layouts.
- 2-BrowseByMetadata.lua - Adds author, title, series, and keyword browser views that slot neatly into Project: Title navigation.
- 2-browser-folder-cover.lua - Pair with Project: Title layouts for folder covers that match the themed grid.
Make Your Own
Clone the 2-userpatch-template.lua starter, rename it with the correct execution-order prefix, and customize the Lua hooks for your workflow.
Missing a favorite patch? Let us know and we’ll add it after verifying compatibility.