18c17829b7
* Input: Harden setCurrentMtSlotChecked The current implementation was assuming that the only case where we might be missing slot storage was for the *first* contact point, given that ABS_MT_SLOT is (if all goes well) guaranteed to be present and come first for every subsequent additional contact points. While this works just fine in practice, we can simplify and generalize the check by just checking if we've actually recorded the requested slot, even if it's not the first contact point. The hit check is possibly ever so slightly faster than the length computation, to boot. * Input: Handle snow_protocol devices with newer hardware revisions that do *NOT* need the snow quirks. If a sane input frame is detected, the snow quirks will be disabled at runtime, ensuring sane behavior. Given the extremely non-standard behavior of the snow quirks, this is fairly easy to detect, as a snow device will *never* emit EV_ABS:ABS_MT_TRACKING_ID:-1, so if we catch one, it's not snow ;). (We've had reports of this on a Clara HD, FWIW) |
4 months ago | |
---|---|---|
.ci | 2 years ago | |
.circleci | 2 years ago | |
.github | 5 months ago | |
base@d83148b27e | 5 months ago | |
doc | 7 months ago | |
frontend | 4 months ago | |
l10n@075e889cdc | 4 months ago | |
metadata | 2 years ago | |
platform | 5 months ago | |
plugins | 4 months ago | |
resources | 1 year ago | |
spec/unit | 5 months ago | |
test@86eeb0b43d | 8 years ago | |
tools | 9 months ago | |
.busted | 9 years ago | |
.codecov.yml | 5 years ago | |
.editorconfig | 8 years ago | |
.gitignore | 4 years ago | |
.gitmodules | 3 years ago | |
.luacheckrc | 2 years ago | |
.luacov | 7 years ago | |
.luarc.json | 11 months ago | |
.shellcheckrc | 4 years ago | |
.travis.yml | 7 years ago | |
COPYING | 10 years ago | |
Makefile | 10 months ago | |
README.md | 7 months ago | |
datastorage.lua | 7 months ago | |
defaults.lua | 5 months ago | |
kodev | 10 months ago | |
reader.lua | 9 months ago | |
setupkoenv.lua | 10 months ago |
README.md
KOReader is a document viewer primarily aimed at e-ink readers.
Download • User guide • Wiki • Developer docs
Main features
-
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, …
Please check the user guide and the wiki to discover more features and to help us document them.
Screenshots
Installation
Please follow the model specific steps for your device:
Android • Cervantes • Kindle • Kobo • Linux • Pocketbook • reMarkable
Development
Setting up a build environment • Collaborating with Git • Building targets • Porting • Developer docs
Support
KOReader is developed and supported by volunteers all around the world. There are many ways you can help:
- fix bugs and implement new features
- translate the program into your language or improve an existing translation
- document lesser-known features on the wiki
- help others with your knowledge on the forum
Right now we only support liberapay donations, but you can also create a bounty to motivate others to work on a specific bug or feature request.