KOReader Patches

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.

1. Create a patches folder inside your KOReader directory (skip if it already exists).
2. Download each user patch and copy the .lua file into /koreader/patches/ without renaming it.
3. Restart KOReader so the new patch loads.

Essential patches for improving the reading experience.

• 2-browser-folder-cover.lua - Add cover art to mosaic folders with optional custom .cover images 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

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.

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.

Patches for screensaver behavior and sleep screen messages.

• 2-screensaver-chapter.lua - Add %C chapter title and %P percent tokens to the sleep screen message.
• 2-screensaver-cover.lua - Center images, refresh before sleep, and tweak night mode behavior for sleep screens.

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 .lua extension (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+).

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
• Stacked Top or Bottom Bars - Reposition and reorganize interface bars for different layouts

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/.jpeg files 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.

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

• 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

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.

Clone the 2-userpatch-template.lua starter, rename it with the correct execution-order prefix, and customize the Lua hooks for your workflow.