An ebook reader application supporting PDF, DjVu, EPUB, FB2 and many more formats, running on Cervantes, Kindle, Kobo, PocketBook and Android devices
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 59a0139a60
File browser: add Folder Menu (#10275)
1 day ago
.ci [CI] Don't hide docs generation log (#9204) 10 months ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 10 months ago
.github Revert "[CI] Set macOS Github Action to macOS 12.00 (#9856)" (#9864) 4 months ago
base@f16948b6c7 bump crengine: fix parsing of multibytes encodings 1 week ago
doc Cleanup various varargs shenanigans (#9624) 6 months ago
frontend File browser: add Folder Menu (#10275) 1 day ago
l10n@a8870e59db Update translations for v2023.03 (#10226) 2 weeks ago
metadata update metadata & translations 5 months ago
platform Bump luajit-launcher for Onyx Poke 4 lite (#10137) 1 month ago
plugins Fix: Updated legacy directory, which crashed the program (#10260) 3 days ago
resources Bookmark flipping mode fix (#10196) 3 weeks ago
spec/unit Center pdf manual zoom mode (#10246) 1 day ago
test@86eeb0b43d various test/coverage optimization 7 years ago
tools [fix] kodev wbuilder crashes with "attempt to index global 'G_defaults' (a nil value)" (#10088) 2 months ago
.busted Travis update 8 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 4 years ago
.editorconfig experimental port to Mac OSX 7 years ago
.gitignore Add macOS target 3 years ago
.gitmodules add basic metadata for F-Droid 2 years ago
.luacheckrc Cleanup various varargs shenanigans (#9624) 6 months ago
.luacov [CI] Also run coverage on plugins (#3447) 5 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 3 years ago
.travis.yml quickstart fix (#2804) 6 years ago
COPYING switch license to AGPLv3 9 years ago
Makefile Support Android AArch64 (#9645) 5 months ago
README.md Readme: update list of supported formats (#10004) 2 months ago
datastorage.lua Datastorage: do not create unnecessary folders (#10162) 1 month ago
defaults.lua Cleanup: Track color constant name change (#9716) 5 months ago
kodev kodev: fix grep: warning: stray \ before - (#10071) 2 months ago
reader.lua Version log and (limited) notifications log (#10178) 4 weeks ago
setupkoenv.lua setupkoenv: ffi.load: search rocks 1 year ago

README.md

KOReader

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.

Screenshots

Installation

Please follow the model specific steps for your device:

AndroidCervantesKindleKoboLinuxPocketbookreMarkable

Development

Setting up a build environmentCollaborating with GitBuilding targetsPortingDeveloper docs

Support

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.

Contributors

Last commit Commit activity