KOReader Document Viewer for E Ink devices

2 years ago (koreader.rocks)

I will never buy an eReader without support for koreader. It's absolutely essential to me, most importantly:

* Lots of quick fixes for poorly chosen CSS properties (called "style tweaks" in koreader), just apply them on-the-fly.

* Support for StarDict dictionaries, which you'll find plenty for all kinds of languages.

* Great PDF support with automatic or manual cropping, and special viewing mode for two columns, perfect for scientific papers.

* OPDS support so than I can easily download books from my Calibre library

* On Kobo, way, way more options to set the backlight (original firmware is way too bright in the dark even on lowest setting), many options to configure "warmth" of the backlight for late-night reading

* Great support for bookmarks

* Super easy to hack and contribute as almost everything is written in Lua

  • Nice list! May I ask what dictionaries do you use (I've just chosen from the internal list, but they seem not that "ideal" after Oxford)? By the way about backlight - on Android there is a bug with that feature: warm light can't be used and also if you start using automatic lighting it does not actually work. Not a big deal: just using system presets from device lighting menu.

  • Another killer feature for me is its built-in support for Wallabag. I host my own server and routinely save longer articles to it so that I can download and read them on my Kobo later.

I have a Kindle paperwhite 3. Without a Jailbreak the backlight of this device is never fully off when you read. Flashing it and using KOReader allows the backlight to be fully off. I have never understood why this is the case.

An important feature to me is being able to ignore epub's CSS rules and embedded fonts that are otherwise enforced.

  • I do often use this feature but sometimes fear I missing out because of some deliberate decisions by the author. Not sure if that worry is really warranted.

The best thing is that it does not seem to hard to extend KOReader to your liking (e.g. by writing plugins). On the other hand, I've had a hard time understanding the the actual Lua code (most likely because of my lack of experience using Lua though!).

What's really missing is a good way to browser by metadata (e.g. author, series or even your own custom tags). However, there seem to be some progress here [0].

[0]: https://github.com/koreader/koreader/issues/8472

The essential bits for me:

- OPDS support including search, so I can grab books from my library with a minimum of fuss.

- page sync support, with the ability to run my own server, so I can switch devices easily. (Phone, 2 tablets, desktop...)

- page display customization ranging from the simple (margins, sizes, fonts) to the detailed (complete custom CSS, if you like)

If I can't quickly set a reader to Palatino or a close relative, left-justified, line height of 1.2, it's a failure for me. KOReader rarely disappoints.

This software has saved my Tolino Shine 2 HD from living in a drawer. Its original software is really buggy and doesn't receive updates anymore. KOReader on the other hand is snappy, configurable, and gets out of my way when I just want to read. The only thing I'm missing is wireless sync, but that's on me...

I use this every single day, for English as well as Japanese books. Absolutely my go-to reader.

As I recall Koreader did not recognize that there are basically two versions of TXT-files.

In the first one paragraph is marked with single Carriage Return.

In the second one the paragraph has two CRs and all single CRs can be replaced with space.

Annoying but bagatel:

    sed ':a;N;$!ba;s/\n\n/XYZ/g'|sed ':a;N;$!ba;s/\n/ /g'|sed 's/XYZ/\n/g'

This website doesn't do much to tell me why I would want to use it. Can anyone explain?

  • The GitHub readme may have been a better link to use, it contains some more information: https://github.com/koreader/koreader

    - portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook, reMarkable), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.

    - multi-format documents: supports fixed page formats (PDF, DjVu, CBT, CBZ) and reflowable e-book formats (EPUB, FB2, Mobi, DOC, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. ZIP files are also supported for some formats.

    - full-featured reading: multi-lingual user interface with a highly customizable reader view and many typesetting options. You can set arbitrary page margins, override line spacing and choose external fonts and styles. It has multi-lingual hyphenation dictionaries bundled into the application.

    - integrated with calibre (search metadata, receive ebooks wirelessly, browse library via OPDS), Wallabag, Wikipedia, Google Translate and other content providers.

    - optimized for e-ink devices: custom UI without animation, with paginated menus, adjustable text contrast, and easy zoom to fit content or page in paged media.

    - extensible: via plugins

    - fast: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.

    - and much more: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, over-the-air software updates, an FTP client, an SSH server, …

    • It also avoids a lot of the bloat that e-reader OSes tend to have for vendor lock-in reasons in favour of giving you software that's actually usable. Especially if you have a slightly older device where they've quietly started to pull the plug on most of the services or have pushed OS updates to the device past the point where the specs of that device can handle it.

      That alone is a big feature that makes KOreaders existence worthwhile.

      The only weakness is that there's no real "true" library view as far as I could find - you're stuck using an SD card browser, which is fine for me but is a notable presentation downgrade.

Great opensource reader! Lots of options. I'd even like someone to make OS with ONLY this program + something to sync books easily. Without that additional bloat like Android readers have nowadays.

It used to crash my Kobo Clara so I uninstalled it. But I see they recently removed the warning about it being crashy, so maybe it's fixed.

It has a great 2-column PDF reader.

It is great, the only thing I coulnd't find is PDF text layer reflow. May be someone knows how to do that?

  • I think it's had it for quite some time, it's at:

    BOTTOM MENU > Aa > Reflow

    It's in the manual:

    PDF documents - Crop margins automatically or manually - Reflow documents to extract text and read easier on a small screen - Different zoom types and page flow directions to read multi-column documents easily - Auto straighten tilted documents - Apply OCR - Special Panel zoom feature for reading mangas

    https://koreader.rocks/koreader-user-guide.pdf