r/koreader

Need help with Plugins and Patches

Hello there, i used to be very active here and loved to tinker with the Koreader on my kindle. But i have gone MIA for a few months and i am seeing a whole bunch of new Plugins and Patches. So if you guys can tell me with your most useful/favourite patches and plugins and what they do, that would help me a alot. I have just installed Bookshelf and i absolutely love it. Cant wait to try more. Cheers

reddit.com
u/complexisbackagain — 10 hours ago

Let’s talk features: What does your ultimate KOReader wishlist look like?

Hey everyone, we all know KOReader is amazing, but no software is ever truly finished.

I wanted to open up a discussion and see what features, custom plugins, or workflow shortcuts you are all actually craving these days. Whether it’s a specific gesture mapping you need, a deep UI customization tweak, or just a small quality-of-life improvement you feel is missing, what would be at the very top of your wishlist if you could add anything?

reddit.com
u/DisastrousPatience83 — 16 hours ago
▲ 2 r/koreader+1 crossposts

How to use 8bitdo zero with Boox Go 7 Color ii?

Hi all! Bought myself an 8bitdo zero as I wanted to have a remote page turner for Koreader and I cannot for the life of me figure out how to make it work.

I’ve already updated the firmware, connected as a keyboard, tried remapping in “key mapper” and am having no joy ☹️

Can anybody who’s successfully managed it help me out? I’d be very grateful!

reddit.com
u/OstrichLate — 13 hours ago

Night Mode Screensaver Patch

Hello everyone!

I noticed that even when Night Mode is on, KOReader shows the sleep screen without night mode applied, so transparent images end up with a bright background. I put together a small patch to fix that and figured I’d share it here. I’ve tested it on the emulator and on my Kobo Clara BW and it seems to work well.

https://preview.redd.it/kisp0z1z2h2h1.jpg?width=539&format=pjpg&auto=webp&s=fd37d50294a588d18ff64afcde1c909f419bda21

If you want to test it out,

You can download the code here:
https://pastebin.com/TrLP60gK

Or copy and paste the code below into a text editor and save it as 2-keep-nightmode.lua then add it to your koreader/patches folder.

local Screensaver = require("ui/screensaver")
local ScreenSaverWidget = require("ui/widget/screensaverwidget")
local Device = require("device")
local Screen = Device.screen

local orig_show = Screensaver.show

Screensaver.show = function(self, ...)
    if Screen.night_mode then
        local snapshot = Screen.bb:copy()
        snapshot:invertRect(0, 0, snapshot:getWidth(), snapshot:getHeight())

        local orig_init = ScreenSaverWidget.init
        ScreenSaverWidget.init = function(widget, ...)
            ScreenSaverWidget.init = orig_init
            local result = orig_init(widget, ...)
            local orig_paintTo = widget.paintTo
            widget.paintTo = function(w, bb, x, y)
                bb:blitFullFrom(snapshot)
                snapshot:free()
                snapshot = nil
                w.paintTo = orig_paintTo
                return orig_paintTo(w, bb, x, y)
            end
            return result
        end
    end
    return orig_show(self, ...)
end
reddit.com
u/Msnbobody — 10 hours ago
▲ 105 r/koreader

Bookshelf v2.2

Bookshelf is a home-screen plugin for KOReader with a focus on books.

v2.2 expands on collection management with bulk editing support as the headline feature.

Some of these features are getting fairly complex in terms of what's possible and how you might want to use them, but the core bookshelf experience is being kept as simple as possible - these are all optional layers available for when you want to go deeper.

What's new:

  • Selection mode + bulk edit. Long-press a book's Select button, a stack, or wire a gesture, then pick books across folders/chips/drilldowns and apply status / collections / rating / refresh metadata / reset / delete files / remove-from-history in one go. Per-book and bulk both stage changes in a draft until you tap Apply.
  • Stack actions get smarter. Long-press any series / author / genre / folder. Add to / remove from / pin to chip bar. When your selection partially overlaps a stack you get explicit "Add X more" and "Remove X already selected" buttons (e.g. select Fiction, then remove Mystery to get a selection of non-Mystery fiction books).
  • Stacks now know about their contents. Folder stacks treat books in subfolders too (so adding "Calibre/Tolkien" picks up everything underneath). Folders also light up when any book inside them is selected, and a new 'Selected/Total' partial badge replaces the count when a stack is partially selected.
  • Status filter now actually filters group views. Set a filter to e.g. "Reading + Unread" on the Genres or Series chip and stacks whose books are all filtered out disappear.
  • Count badges on folder cards, with format options. Two new settings: "Stack count badge" (Off / Folders only / Groups only / All) and "Stack count format" (Total or Finished / Total). Pick the second to see "you've finished 12 of 47 in this genre" at a glance.
  • Hero card polish. A couple of community suggestions from GitHub implemented here, thanks for the input - Long titles balance their wrapping (no more widow words on the last line) and use tighter line height so the title reads as one unit (#58). The currently-reading icon stays visible while drilled into a series or folder - tap it to pop your open book back into the hero without leaving your view (#59).
  • Home folders sort by content. "Most recently opened" now bubbles a folder up when any book inside it was opened recently, instead of pinning every folder to the never-opened tier. KOReader's "Folders and files mixed" toggle is now honoured too, and changes refresh bookshelf immediately.
  • New chips land next to where you were. Pin from a stack or use the editor's + Add and the new chip lands next to the chip you're currently on, instead of being shunted to the end of the strip.

Download / install: https://github.com/AndyHazz/bookshelf.koplugin/releases

Full notes in the release. As always, feedback / issue reports / feature requests very welcome on GitHub. Although they're piling up a bit! I'll get round to addressing most of them in time, but still focusing on rounding out the core bookshelf feature set.

u/AndyHazz — 1 day ago

Simple UI no covers problem

Can somebody help me? Just recently I installed the Simple UI plugin and updated KOReader.

However I'm having a problem as not a single book has cover in the Simple UI menu. When I open a book and block the screen, I can see the cover of the book in there, but it just doesn't show up in any book in the library or home screen (the books just show as white text on a box).

Edit: Fixed. Make sure to have Cover Browser ticked on in your plugins menu. After doing so Hamburger Menu - Extract and Cache book information - Here and Under.

reddit.com
u/Dry_Cookie_4724 — 1 day ago

Sell Jailbroken Kindle

I have a jailbroken Kindle Paperwhite 10th gen, jailbroken and running Koreader. I am wondering if it is possible to remove my Amazon account from it while still retaining the jailbreak and Koreader. I would like to sell it and get something running android, but don’t want them having access to my amazon account.

Or would it be easier to just return it back to stock? Is that possible?

reddit.com
u/hired_killer88 — 20 hours ago
▲ 82 r/koreader+1 crossposts

I added vertical text (tategumi) support to KOReader fork

I'm a Japanese user who jailbreaks Kindle to read Japanese novels with KOReader. I wanted proper vertical text (縦書き) support, but existing Lua-only patches felt like workarounds to me. I checked upstream PRs but it didn't seem like something they'd take on.

So I forked KOReader and implemented vertical-rl rendering at the engine level (crengine), rather than patching around it in Lua. Existing KOReader features should all still work — I just added the vertical text engine on top.

What works:

  • Japanese EPUBs with writing-mode: vertical-rl
  • Ruby annotations (ルビ)
  • Character rotation (ー、…、括弧類 etc.)
  • Text selection and highlights

There may still be bugs. If you're in a similar situation — jailbroken Kindle or Kobo, wanting to read Japanese novels vertically — feel free to try it.

https://github.com/m-tky/koreader-tategumi

Big thanks to the KOReader developers for building such an extensible platform. None of this would have been possible without their work.

u/Extension-Bed7310 — 1 day ago

Plug-in or patches for reader

Hi guys!

The dev community is totally active on plugins or patches for home screen, browser or library but the reader part is forgotten.

Any reason for that? Isn't possible to develop for reader interface / menus?

reddit.com
u/Curiosity73 — 1 day ago

[RELEASE] Derainbowify v0.0.5

Hello everyone!

I've released a new plugin that allows you to remove the rainbow artifacts on color e-readers such as the Kobo Libra Color, Kobo Clara Color, Kindle Colorsoft, and Pocketbook Inkpad Color 3. It adds an option called "Derainbow" which allows you to remove them directly on your device. This is most useful for black and white comics and manga.

How does it work?

It's similar to the "Reduce rainbow effect" toggle found in the official Kobo software, but it doesn't blur the image and keeps its sharpness. It uses the same method found in Kindle Comic Converter which is the use of discrete Fourier transforms. You can also make it turn on automatically with either profiles or by holding down on the option to set its default value.

There is only a slight delay for rendering new pages, but the automatic pre-rendering of pages makes this unnoticeable when reading. Performance may be improved in future releases.

Where do I get it?

To install/update the plugin, you can look at the releases page.
I only own the Kobo Libra Color, so I couldn't properly test how well it works on other devices, but if there are any problems you may create an issue on the repository.

Credits

Most of the heavy lifting was done by Its-my-right and their patch for the Inkpad Color 3 as well as their work in Kindle Comic Converter, and the idea to use Fourier transforms came from Blendman974. The above image (to the left) showing the rainbow artifacts is from this blog post by Renkon.

Links

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

Repository: https://github.com/Euphoriyy/derainbowify.koplugin
Releases: https://github.com/Euphoriyy/derainbowify.koplugin/releases
Issues: https://github.com/Euphoriyy/derainbowify.koplugin/issues
Ko-fi: https://ko-fi.com/euphoriyy

u/OneAdvance6339 — 2 days ago

Suddenly painfully slow on Kindle

I had a few days off so I spent way too much time trying out plugins. For a few days now, koreader on Kindle Oasis is painfully slow. I never experienced that in the last 5ish years. At this point I think a clean install would be a good idea. Can anybody help me out how to do this?

reddit.com
u/rock_in_steady — 1 day ago

Using KOReader for the first time. I must confess I'm struggling a bit

Hi, my old Kindle PW gen 3 has gone through the jailbreak process a few weeks ago and for the first time ever I'm discovering the benefits of getting out of Amazon's awful jail.

I have gone through some of KOReader menus -- it definitely has a huge amount of settings and possibilities that I barely imagined before. Setting up text format with more liberty (my initial goal for jailbreaking) was barely the beggining!

I must confess though that the interface is painfully complicated for new users who are coming from your typical GUI -- the questionable location of some buttons (I mean, some as basic as the one to go back to the library or to the previous menu), the constant appearance of obscure settings that have no reason to exist when you are reading...

I recently learned about SimpleUI, which I guess must be a popular plugin around here, and at least it solved some of my issues with the "home screen".

However, I still struggle with some stuff that I can't and won't ever get used to -- that intricate top bar, the rather ugly interface that pops up when I press the screen while reading a book...

Are there plugins that could help me simplifying the whole KOReader experience? :-(

reddit.com
u/metacognitive_guy — 2 days ago

Syncing Progress From Xteink X4 and Kobo Libra 2

Solved: I did two things that potentially solved this. I made sure the books were the exact same binary file and I switched to crossink. The problem does seem to be fixed now! thanks for your help!

Hello. I have researched this issue and I am just not clear if I am doing something wrong or perhaps this is just a known bug. I am attempting to read using a couple of devices. I'll provide all the information I can.

I mainly read on a Kobo Libra 2 with Koreader and Simple UI installed. I have successfully gotten my progress from books synced with KoSync and Readest (app and program).

I recently got the Xteink X4 and was able to put Crosspoint on it . I have setup to do KoSync.

When I am done reading on the Kobo, I tell it to sync with Kosync. I am successful getting my progress from the Kobo onto the Xteink. It works every time.

However, when I read on my Xteink and upload progress via Kosync, my Kobo never receives the proper placement. It keeps going back to 64% when I have read up to 70%.

I tried using the Readest using it's KoSync feature. However, it's not working either.

Is this a known issue, or am I doing something strange here? Any help is appreciated.

reddit.com
u/BathApprehensive4493 — 2 days ago

Problem with Bookshelf

Hello,

maybe someone can help me quick.
I have installed the latest version of Bookshelf and I like it. But I have 2 problems:

  1. I cannot find the option toset it as the main start page. I have also Project: title installed, but from my understanding it should be no problem.

  2. When I'm in Bookshelf I cannot access the normal Koreader menu by clicking the top part of the display. I always have to open a book and then I can access the menu again. Is that normal?

Thanks a lot in advance!

reddit.com
u/0l0l123 — 2 days ago

Crossword Puzzle Plugin for KOReader

This plugin supports:

  • .puz and .ipuz files
  • Daily free puzzles from sources like USA Today, Universal, WSJ, Guardian, Newsday, Jonesin’, BEQ, and more
  • NYT archive puzzles from 1977 to today
  • Crosshare imports via URL or ID
  • Offline puzzle generation from StarDict dictionaries, books, or Vocabulary Builder data

Progress is saved automatically, and puzzles can be replayed offline.

(Developed entirely with AI assistance.)

Repo:
https://github.com/omer-faruq/crossword.koplugin

u/SecretaryKlutzy7992 — 3 days ago

My setup with SimpleUI, Bookshelf, Shortcuts Toolbar and some patches +custom icons from Iconify (and yes, with the obligatory Project Hail Mary lmao)

I used the Material Symbols pack from iconify.design to change SimpleUI's icons from the menu, and to replace all system (and Shortcuts Toolbar's) icons in koreader/icons. (also, i can zip and link the folder in the comments if anyone wants this, but does not want to find, download and rename all the icons one-by-one)

I use Bookshelf as my library (it closes with a gesture).

There are some patches too, like the ui font changer or the cvs receipt.

Does anyone know why doesn't Shortcuts Toolbar show book info (even though it's enabled in the menu)?

u/oryctes_nasicornis_ — 3 days ago

Pencil.koplugin - v0.5.0 - Orientation change support and annotation bookmark previews

I'm really excited about this one! This update includes:

  • Annotation previews in bookmarks (if you have the bookmark sync turned on). In order to see them, you'll need to revisit any old annotations from the bookmark menu and then you will be able to long press to preview, short press to to go that bookmark.
  • Orientation change support. If you make an annotation in portrait mode, and change to landscape, an icon will appear that lets you see what you wrote over the part you wrote it on, similar to how the native Kobo software works.
    • Note: when changing orientations, it may take a moment for the document to reformat itself and for the annotations to go back to where they were.
  • Performance updates. Boring but necessary!

https://github.com/mysticknits/pencil.koplugin/releases/tag/0.5.0

u/mysticknits — 3 days ago