These are the user patches I use daily on my own KOReader install. Feel free to use, copy or change them. Install steps are here: how to install user patches.
Helper script: ./deploy-patches.sh <host> [port] uses SSH/SCP to copy all local .lua patches.
Warning
This script removes the current files in /mnt/onboard/.adds/koreader/patches on the target before copying.
Note
Patches that start with 2-pt- only work with the Project: Title plugin.
Adds section-aware items to the reader status bar:
- section progress
- section pages left
- section time to read
- section title
Goal: pin one status bar preset to chapter title + chapter progress, and another preset to section title + section progress.
Then use 2-statusbar-cycle-presets to switch between them while reading. That gives you one status bar for general overview and one for the current section.
This screenshot shows all of that info together in one view: [chapter title] [chapter pages/total in chapter] [empty space] [section pages/total in section] [section title]
Project: Title only.
Adapted local patch for the file browser title bar.
Mostly adapted by changing toolbar buttons and actions.
WireGuard plugin used by this setup: WireGuard plugin README
Sources:
- https://github.com/joshuacant/KOReader.patches/blob/main/2-toolbar-replace-button.lua
- https://github.com/joshuacant/KOReader.patches/blob/main/2-toolbar-add-buttons.lua
License: derived from AGPL-3.0 upstream code, see AGPL-3.0.txt.
Adapted local patch for a simple reader header.
Current layout is title and author on the left, and time on the right.
Source: https://github.com/joshuacant/KOReader.patches/blob/main/2-reader-header-cornered.lua
License: derived from AGPL-3.0 upstream code, see AGPL-3.0.txt.
Restyles the built-in banner sleep screen so it looks more like a Kobo lockscreen with nice title screen.
Project: Title only.
Trims Project: Title footer widgets down to a smaller set of items.
I only display clock and battery widgets.
Source: https://github.com/joshuacant/KOReader.patches/blob/main/2-reader-footer-widgets.lua
Lets you cycle through your status bar presets by tapping the status bar.
Source: https://github.com/sebdelsol/KOReader.patches/blob/main/2-statusbar-cycle-presets.lua
Adds chapter markers to the thin status bar.
Source: https://github.com/sebdelsol/KOReader.patches/blob/main/2-statusbar-thin-chapter.lua
Default license for this repo's original files: MIT, see LICENSE.
Exception:
- 2-pt-header.lua is derived from AGPL-3.0 upstream code and remains under AGPL-3.0-or-later, see AGPL-3.0.txt.
- 2-reader-header.lua is derived from AGPL-3.0 upstream code and remains under AGPL-3.0-or-later, see AGPL-3.0.txt.
Made by Wouter ten Brinke