KOReader.patches

Useful patches for KOReader that I have either compiled, edited, or created myself.

🞂 2-dim-during-refresh.lua

This patch lowers the brightness during refreshes in night mode to prevent bright flashes on e-ink. Based on this post by LexamusPrime.

It can be configured under 🞂 Screen 🞂 Dim frontlight on refreshes on the Settings tab.

It has the following options:

• A toggle to enable dimming.
• A toggle to force dimming every page turn/refresh.
• A toggle for dimming on UI refreshes.
• A toggle for dimming in the reader only.
• A toggle to dim relative to the current brightness.
• A numeric stepper for the level of dimming (absolute/relative).

🞂 2-filemanager-next-prev-page-actions.lua

This patch adds dispatcher actions (assignable to gestures) for going to the next or previous page in filemanager.

Made for kobo.koplugin.

🞂 2-correct-screen-borders.lua

This patch adds border lines to the sides of the screen to correct for e-ink issues. Made for this post by wigglytoad.

It can be configured under 🞂 Screen 🞂 Border correction on the Settings tab.

🞂 2-percent-badge.lua

This patch adds a customizable badge that displays the percentage read for each book. It also displays whether a book has been completed or paused.

It has inline option variables at the start of the file.

In comparison to the original, it adds two new additional features:

• The ability to not be inverted in night mode when used together with the UI background color patch.
• The inline option to exclude the text color from being modified by the UI font color patch.

Edited from the version by angelsangita.

🞂 2-rounded-covers.lua

This patch adds rounded corners to the book covers in the file browser.

The core feature that distinguishes this version is that it is background-agnostic, meaning that it works on any background without requiring any corner icons. Due to that, this patch works well with the Appearance plugin.

Based on the original patch by SeriousHornet.

🞂 2-rounded-folder-covers.lua

This patch adds rounded corners to the folder covers in the file browser.

The core feature that distinguishes this version is that it is background-agnostic, meaning that it works on any background without requiring any corner icons. Due to that, this patch works well with the Appearance plugin.

It also adds an option to show/hide the file count.

Based on the original patch by SeriousHornet.

🞂 2-rounded-covers-for-simpleui.lua

This patch adds rounded corners to the covers used in SimpleUI.

This patch is background-agnostic, meaning that it works on any background without requiring any corner icons. Due to that, this patch works well with the Appearance plugin.

The radius, or in other words the roundness of the covers, and border thickness can be adjusted at the top of the patch.

🞂 2-custom-widgets.lua

This patch adds support for custom widgets that can be used by other patches and plugins.

Widgets are auto-loaded from: <koreader_dir>/widgets/

Each .lua file in that directory is loaded and registered under its filename (without the .lua extension). For example: widgets/colorwheelwidget.lua → "colorwheelwidget"

Information on how to use it in patches/plugins can be found in the patch comments.

🞂 2-custom-pan-rate.lua

Important

This patch aims to provide smoother scrolling but will hurt performance in return. This cannot be overcome without GPU rendering.

This patch adds an option for selecting a custom pan rate which allows for smoother scrolling. It defaults to the screen's refresh rate on Desktop or KOReader's default of 30 Hz.

It can be configured under 🞂 Taps and gestures 🞂 Gesture intervals 🞂 Pan rate on the Settings tab.

Made for koreader/koreader#12947.

🞂 2-sw-page-turn-animation.lua

This patch adds a software-based page turn wipe animation. This version adds support for all devices (Kindle, Kobo, etc.) and fixed-layout documents (PDFs, CBZs, DJVUs, etc.).

It can be configured under 🞂 Taps and gestures 🞂 Page turns on the Settings tab.

Based on the patch by federico1176-wq and original feature by @huangyingkanghuang-ux.

Related to koreader/koreader#15468.

Obsolete Patches

🞂 2-invert-document.lua

Warning

This patch is now obsolete as of the newest release (v2026.03) with koreader/koreader#14954. It should be removed when updating to new releases or the nightly.

This patch adds a document option to invert CBZs/PDFs in night mode. It is useful for reading comics/manga in night mode.

Made for koreader/koreader#9899.

---

Important

The features of the following patches have been merged into appearance.koplugin.

🞂 2-progress-bar-color.lua

🞂 2-ui-themes.lua

🞂 2-ui-font-color.lua

🞂 2-ui-background-color.lua

🞂 2-ui-background-image.lua

Widgets

Widgets allow for additional functionality for patches. Developers use them to provide unique ways to configure options.

How do I install widgets?

You can install widgets by using the custom widgets patch. After installing that patch, you have to create a custom widgets folder (just like the patches folder) inside of the koreader directory. Any widgets can now be placed inside this new widgets folder.

🞂 colorwheelwidget.lua

Adds a visual color wheel for selecting colors. It can be used with numerous different options.

The options are:

• title_text
• width
• width_factor
• hue
• saturation
• value
• invert_in_night_mode
• draw_scale
• cancel_text
• apply_text

Support

If you want to support me, you can star this repository or buy me a coffee. :)

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for full details.