← Back to Home

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.

Installation

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

Browser Enhancements

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.

UI & Menu Tweaks

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-change-status-bar-color.lua - Change status bar read/unread colors under Status bar → Progress bar → Thickness, height & colors.
2-disable-top-menu-zones.lua - Disable the swipe/tap hotzones so the top menu always reopens on its last tab.

Status Bar Helpers

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.

Screensaver Tweaks

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.

Patch Utilities

2-update-patches.lua - In-app updater for this patch collection (requires KOReader v2025.04.107+).

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

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.

Credits

sebdelsol – Curated the patch library and original documentation.

Missing a favorite patch? Let us know and we’ll add it after verifying compatibility.