koreader

An ebook reader application supporting PDF, DjVu, EPUB, FB2 and many more formats, running on Kindle, Kobo, PocketBook, Ubuntu Touch and Android devices

Github stars Tracking Chart

KOReader

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

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

Download
Wiki
Developer docs

Main features

  • portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook), 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, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library.

  • 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), Evernote (export hightlights), 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

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

Please check 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

Development

Setting 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:

At this moment we don't support any form of monetary donation, but you can create a bounty for the specific bug or feature request you want and motivate others to do the work.

Also if you have and old Pocketbook device you don't want, we might find it useful to tinker a bit with that platform. Please contact us through the forum or GitHub.

Contributors

Last commit
Commit activity

0
1
2
3
4
5
6
7

Overview

Name With Ownerkoreader/koreader
Primary LanguageLua
Program languageLua (Language Count: 6)
Platform
License:GNU Affero General Public License v3.0
Release Count261
Last Release Namev2024.04 (Posted on 2024-04-29 21:27:22)
First Release Namev2012.03 (Posted on 2012-03-19 00:21:45)
Created At2013-03-24 13:09:42
Pushed At2024-06-09 19:34:22
Last Commit At2024-06-09 22:34:22
Stargazers Count15.6k
Watchers Count310
Fork Count1.2k
Commits Count10.5k
Has Issues Enabled
Issues Count5802
Issue Open Count671
Pull Requests Count5423
Pull Requests Open Count20
Pull Requests Close Count339
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private
To the top