A KOReader plugin that displays reading statistics and book information on your sleep screen with extensive customisation options and the ability to save/load preset configurations.
Originally released as a patch, this project has now been rebuilt as a KOReader plugin.
- Book progress, chapter progress, daily reading/goal progress, battery stats
- Random book highlights (with location), or custom messages
- Save and load your own configurations, with 10 built-in presets included
- Automatic preset switching between two presets, by schedule or by KOReader's night mode
- Light/dark/monochrome modes (suitable for non-colour e-readers)
- Background options: book cover (with optional overlay), custom image, images from folder, solid colour or transparent.
- Coloured progress bars for percentage stats with option to place inline with text
- Customise info-box background and text colour
- Dynamic icons for sections, with 7 icon sets included
- Reorder sections, adjust section spacing, show/hide elements
- Customise layout, padding, position, opacity, borders, font face/size, text alignment, corner rounding
- Option to clean chapter title (remove prefixes like "Chapter 5:", leaving chapter names only)
- Shows in file manager (displays last book's data) or optional alternative background-only sleep screen for the file manager, independent of your presets
- Choose whether daily stats apply to all books or the current book only
- Quick access through taps and gestures shortcuts
- Sleep screen orientation lock
- Supports hidden flow and stable page numbers
- Export sleep screen as image for use with android screen saver.
- Language support for 16 languages:
de,es,fr,hu,it,ja,ko,nl,pl,pt_BR,pt_PT,ru,tr,uk,vi,zh_CN
The following list assumes KOReader’s latest build (2026.03 Snowflake) is installed and summarises the compatibility to the best of my knowledge.
| Device | Status | Notes |
|---|---|---|
| Kobo | ✅ Works | Most supported platform. Tested on Kobo Libra Colour. |
| Kindle | ✅ Works | Tested on Kindle PW 10th Gen. |
| Android / Desktop | 🟠 Partial support | KOReader’s Sleep Screen feature is unavailable on these platforms however an image can be exported to use with the devices screensaver. |
| PocketBook | 🟠 Partial support | Device firmware overrides KOReader’s Sleep Screen, but an exported image can be set as PocketBook’s own sleep image. Note: PocketBook caches this image, so a reboot may sometimes be needed to see updates - not ideal for frequently updated book stats but it's the best solution currently for this device. |
| Cervantes / reMarkable | 🟡 Unverified | Untested on these devices. |
- Custom icon sets: Add your own icon sets to the plugin’s icon directory using the same folder and naming structure as existing icon sets. PNG, JPG, and SVG formats are supported. SVG files will be recoloured when the recolour option is enabled in settings
- Custom fonts: Add
.ttfor.otffiles to the KOReader fonts directory if you want to use your own fonts - Quick access shortcuts: Add preset menu access, preset cycling and settings access through KOReader’s taps & gestures. The options can be found in the taps & gestures general category
- Better visibility on wake: Enable "Postpone screen update after wakeup" in settings to show sleep screen with front-light when waking up the device
- Download
customisablesleepscreen_vx.x.x.zipfrom the latest release - Extract the zip and place the
customisablesleepscreen.kopluginfolder into your KOReader/pluginsfolder - Restart KOReader
- Enable the plugin in 'Settings → Screen → Customisable Sleep Screen'
- A .pot template file is included in the
l10nfolder. You can use this to create a translation for any language. - Make a copy of the .pot file and rename as a .po with your language locale (e.g. es.po, fr.po, it.po etc.).
- Open the file with a text editor or a dedicated program like Poedit and fill each msgstr with your translation. For ease, I have split the main display strings (those shown on the sleep screen) into their own section at the top of the file if that's all that's important to you for translation.
- Save the .po file in the
l10n/folder and restart KOReader to see it available as an option in the language menu.
- Fonts are from Google Fonts, used under the SIL Open Font License. OFL license files are included in ‘customisable-sleep-screen-fonts/’ for each font
- Icons are from the following sources (some have been modified from the originals):
- Default icons: Solar - licensed under CC BY 4.0
- Pixel icons: Pixel - licensed under CC BY 4.0
- Sketch icons: Doodle - licensed under CC BY 4.0
- Silhouette icons: MaterialDesign - licensed under the Apache 2.0 License
- Fluent icons: Fluent Emoji - licensed under the MIT License
- Circle icons: Tela Circle - licensed under the GNU GPL v3.0
- Comic icons: Custom icon set created for this project
- Wallpaper sets are from two sources, and have been cropped to suit e-reader dimensions:
- Nordic-wallpapers was used for the Nord wallpaper set, licensed under the MIT License
- Walls-catppuccin-mocha was used for the Catppuccin wallpaper set. No license is specified. The repository appears to collect third-party artwork from various sources, so original rights likely remain with the respective artists