You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
hius07 aabd6d7a26
File browser, Collection: improve group actions (#11178)
Maintain correct records in History and Favorites when moving/deleting folders or group of files.
Optimize Collection module to minimize storage requests.
2 days ago
.ci [CI] Don't hide docs generation log (#9204) 2 years ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2 years ago
.github Bump actions/checkout from 3 to 4 (#10890) 3 months ago
base@48225b17ac Bump base 4 days ago
doc [doc] Building targets: remove mentions of Ubuntu Touch (#10974) 2 months ago
frontend File browser, Collection: improve group actions (#11178) 2 days ago
l10n@d399f35c4a Update translations for v2023.10 (#11053) 1 month ago
metadata update metadata & translations 1 year ago
platform Bump android/luajit-launcher 2 weeks ago
plugins Profiles: fix update actions in gestures (#11175) 2 weeks ago
resources Bookmark flipping mode fix (#10196) 9 months ago
spec/unit File browser, Collection: improve group actions (#11178) 2 days ago
test@86eeb0b43d various test/coverage optimization 7 years ago
tools getProps: centralize 2 (#10837) 3 months ago
.busted Travis update 8 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 5 years ago
.editorconfig experimental port to Mac OSX 8 years ago
.gitignore Add macOS target 3 years ago
.gitmodules add basic metadata for F-Droid 3 years ago
.luacheckrc Cleanup various varargs shenanigans (#9624) 1 year ago
.luacov [CI] Also run coverage on plugins (#3447) 6 years ago
.luarc.json Add a config file for the Lua LSP (#10611) 6 months ago
.shellcheckrc [CI] Add curly braces check (#5809) 4 years ago
.travis.yml quickstart fix (#2804) 7 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile android: update to use NDK 23c 5 months ago README: update user guide link (#11000) 2 months ago
datastorage.lua Add hash-based document metadata storage option (#10945) 2 months ago
defaults.lua Gestures: Make the edge swipe zones configurable 2 weeks ago
kodev Never export LD_LIBRARY_PATH 5 months ago
reader.lua Main: Move the G_reader_settings flush to Device:exit 4 months ago
setupkoenv.lua Env: Actually use the full ffi.load signature in our overload 5 months ago


KOReader is a document viewer primarily aimed at e-ink readers.

AGPL Licence Latest release Gitter Mobileread Build Status Coverage Status Weblate Status

DownloadUser guideWikiDeveloper 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.



Please follow the model specific steps for your device:



Setting up a build environmentCollaborating with GitBuilding targetsPortingDeveloper docs


KOReader is developed and supported by volunteers all around the world. There are many ways you can help:

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.


Last commit Commit activity