Home - koreader/koreader GitHub Wiki

KOReader WIKI

KOReader is a document viewer for E-ink devices. Supported document formats include PDF, DjVu, XPS, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, EPUB, DOC, MOBI, and ZIP files. The latest Kindle and Kobo devices are supported. The original software stays available to use after installation.

reflow of complex PDF's using k2pdfopt
saving and exporting notes to files or Evernote
custom .ttf [Fonts]] and [stardict dictionaries
cloud storage (Dropbox, FTP) and synchronization
content providers: Wikipedia and OPDS

An extended survey can be found on Features list or jump directly to Configuration, Community.

Getting started

Some of the content on the WIKI might be out of date. You are welcome to make it better by opening an issue if you find any of the instructions unclear or confusing.

First-time users need to setup KOReader based on device brand. Please follow the model specific steps on one of the following pages: Android, Cervantes, ChromeOS, Kindle, Kobo, Pocketbook, ReMarkable or Desktop Linux.

Installation/Upgrading

Make sure that you have completed the preceding setup completely. Save the settings of any existing KOReader installation if necessary before upgrading. (Long pressing certain menu actions will save the program's defaults automatically to a separate file defaults.persistent.lua. See Change defaults for making manual changes.)

Using Wi-Fi

Assuming you have already installed KOReader successfully, enable Wi-Fi and connect to the internet. Use KOReader's top-right menu to check for a new version. You can check for upgrades on predefined stable or development channels.

Connected as a USB mass storage device

Choose the KOReader build archive appropriate for your device from the following channels:

nightly builds: generated automatically overnight. These builds sometimes contain severe bugs (tracked in the issue tracker), but they also contain the latest daily patches.
stable builds: released once a month. Release notes are included with the release.
custom builds: build it yourself.

Unpack the downloaded archive in the right folder on your device (see device-specific setup instructions for finding the correct path) to install/upgrade.

Configuration

After starting up KOReader, all you need to do is navigate the file manager to a (hidden) library folder and set it as default by long-pressing the file name. Files with supported file extensions will show up in this file manager. Touch gestures for navigating the user interface are explained in gestures and multiswipes. You can read more about lesser known useful functions here, and there's a large survey of features including explanations here.

Development community

KOReader is a rewrite of "kindlepdfviewer", which was originally built by hawhill based on the mupdf source. Since then it has come a long way, based on requests and updates by hackers around the world. The name "KOReader stands for Kindle/Kobo Open Reader, the devices for which KOReader originally was written.

Users

You can open new issues on the issue tracker. There are related discussion threads on the MobileRead Forums, one of the largest English language web forums for e-book reading/publishing:

Hackers

Contribute by writing code.