KOReader Patches

Desription

For SCREEN SAVER

These patches are applied to the Sleep Screen

Kobo-style Sleep Banner

Redesigns the built-in 'banner' type sleep screen message to look like the native Kobo sleep screen style.

Mod:

• Menu toggle: Turn On/Off the patch.
• Menu toggle: "Avoid Night Mode" so the banner colors aren't inverted.
• Added Smart Title Case with small words ignored to avoid All-Caps titles.

Settings:

• Set your custom Sleep screen message in Settings > Screen > Sleep Screen > Sleep screen message > Edit sleep screen message, use the info button for all the available variables.
• In Settings > Screen > Sleep Screen > Sleep screen message set Container and position to Banner. Set the Message Opacy and Vertical position for the box here as well.
• The patch adds the title followed by your custom sleep screen message. The default is Book title; you can change it inside the patch code.
• Settings inside the patch code: Text to use for title, bg color, margin, font, font size, border, border size and color.

📌 Original patch by u/hundredpercentcocoa > I modded this patch before the "Highlights" feature was added.

🗒️ Notes:

Since the cover already shows the book title, I set mine to show the current chapter followed by my custom message.
My custom message: pages left in chapter >> Time left in chapter. New Line with dashes. New line: Current page/total pages * % read. New line: Time left in book.
You can add new lines by pressing the ENTER key.

📂 2-kobo-style-sleepscreen-banner.lua

Screensaver Utilities

Adds 4 new toggles at the end of the "Sleep screen" menu:

• Close widgets before showing the screensaver
• Refresh before showing the screensaver
• Force NO FILL for images when in File Browser
• Center and shrink book cover

By default it doesn't change the sleep screen behavior.

📌 Original patch by sebdelsol > after Koreader change the screensaver widgets the patch needed an update, this patch does not include the "No ovelap" feature form the original patch.

🗒️ Notes:

Force no fill: I have my screensvar set to Ignore book cover > When in file browser this mean that when my device goes to sleep while in file browser, custom images (which have transparent background) will show instead of the book cover, but since I want my book covers to have a fill when sleeping while in reader, this option will force to use No fill when sleeping in file browser without needing to change the fill manually.

📂 2-screensaver-utilities.lua

---

For FILE BROWSER

These patches are applied to the File Browser

Book Spine Effect

Adds a realistic "book spine" effect simmilar to Apple Books to the edge of cover thumbnails in the Mosaic/Grid browser.

Mod:

• Removed the rendering spine drawing.
• Recreated the actual Apple Book spine images.
• Add a shadow to the image so the spine is also visible on white covers.
• Add a toggle in Settings > Mosaic and detailed list settings to turn ON/OFF the effect.
  
  

Settings:

• Save this image book.spine.png inside the koreader > icons folder.
• Settings inside the patch code: spine width, intensity and offset.
  
  

📌 Original patch by advokatb

🗒️ Notes:

Even though the image and the code are optimized for better cache, this effect may consume a lot of memory and slow down your device, avoid using other heavy patches like recurring count, total page in book, etc.

📂 2-MM--Book-spine-effect.lua

Faded Cover Effect for Finished Books👑

Automatically reduces the opacity or greys out the covers of books that have been marked as "Finished" in the browser view.

📂 View Code

Browse by Metadata

Enhances the file browser capabilities, allowing for navigation and sorting based on specific book metadata tags.

📂 View Code

Folder Cover

Allows folders in the file browser to display a cover image (e.g., `folder.jpg`) instead of the generic folder icon.

📂 View Code

Confirm First Time Opening

Adds a confirmation dialog or prompt when opening a book for the very first time, preventing accidental opens.

📂 View Code

Cover Browser Mosaic Stretched

Modifies the Mosaic grid view to stretch cover images to fill the entire tile area, removing whitespace.

📂 View Code

Dynamic Mosaic Layout

Adjusts the number of columns and rows in the Mosaic view dynamically based on the device orientation or screen size.

📂 View Code

Filemanager Title Bar

Customizes the appearance or contents of the top title bar when navigating the file manager.

📂 View Code

New Cover Progress Bar

Replaces the standard progress bar with a customized "MM" style version, likely cleaner or thinner.

📂 View Code

New Cover Status Icons

Updates the system status bar icons (battery, wifi, light) with a new custom icon set.

📂 View Code

Cover Total Pages Badge

Overlays a badge on book covers in the library view showing the total page count.

📂 View Code

New Cover Progress Badge

Overlays a small badge on book covers displaying the current reading percentage.

📂 View Code

Series Indicator

Adds visual indicators or numbering to covers to clearly show series order information.

📂 View Code

Browser Up Folder

Customizes the "Up Directory" (..) folder icon or behavior in the file browser.

📂 View Code

Custom Underline Container (Last Focus)

Modifies the container logic for underlines, likely adjusting thickness or style for links/highlights.

📂 View Code

Disable Top Menu Zones

Disables specific touch zones associated with the top menu to prevent accidental taps.

📂 View Code

Menu Size

Provides options to adjust the global scaling or font size of the main menu interface.

📂 View Code

New Cover Collections Badge (Star)

Adds a star icon to books in the browser to indicate they belong to a collection.

📂 View Code

Rounded Corner Covers

Applies a border-radius to cover thumbnails, giving them rounded corners in the browser.

📂 View Code

Change UI Font

Overrides the default system UI font with a custom user-defined font.

📂 View Code

---

For the READER

These patches are applied to the Reader

Reading Insights popup

Adds a popup feature that displays detailed insights about your reading session.

📂 View Code

Better Compact Status Bar

A compact layout for the status bar designed to maximize reading space while keeping info visible.

📂 View Code

2-custom-highligh-colors

Allows the user to define custom hex codes for text highlight colors.

📂 View Code

Customise Progress Bar Colour gui

Adds a GUI menu option to easily change the color of the reading progress bar.

📂 View Code

Bigger Dog-ear (corner bookmark)

Increases the visual size of the "dogear" triangle used to mark pages.

📂 View Code

Show Chapters in Highlights

Updates the highlight browser to display the chapter name alongside the highlighted text.

📂 View Code

Mini-receipt Patch

A composite patch that creates a "mini receipt" style layout, likely combining progress bars and footer stats into a unified compact view.

📂 View Code

Reader Header Print-edition

Modifies the reader header layout to resemble a print edition, possibly showing header text or page numbers differently.

📂 View Code

Reading Stats popup

Enables a popup that displays current reading statistics such as speed and estimated time left.

📂 View Code

Reference Pages Counter

Forces the display of the reference (real) page count instead of the calculated screen count where available.

📂 View Code

Statusbar Thin Chapter

A variation of the status bar that is thinner and focuses on displaying chapter progress.

📂 View Code

Vocabulary Builder Button

Adds a button to the reader interface for quickly adding words to the Vocabulary Builder.

📂 View Code

Double Progress Bar

Displays two concurrent progress bars, typically one for chapter progress and one for overall book progress.

📂 View Code

Set Translation Language per-document

Allows the translation target language to be saved specifically for each document rather than globally.

📂 View Code

Book Title in TOC

Tweaks the display of titles within the Table of Contents, possibly adjusting truncation or font style.

📂 View Code