Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Installation on Kindle devices
Clone this wiki locally
KOReader can be installed on all jailbroken Kindle devices.
NOTE: The ability to jailbreak a Kindle device depends on both the model, the specific variant of its model, and the current firmware version it's running. Detailing all of the intricacies this can involve is out of scope for this document, so, please check the current state of things on MobileRead. Currently, this wiki page should be a good starting point. In general, the newer the device, the trickier it gets.
Certain minor features may currently still be unavailable on non-touch devices such as the Kindle 4 (NT) and earlier. Don't hesitate to check and open an issue if you encounter such a problem.
Besides the reader itself, you will also need to install a launcher. For that purpose, you can use KPVBooklet or KUAL, or even both.
- Jailbreak your Kindle, refer to this post or others, depending on your device.
- Install a launcher
- Install KOReader
- Download the latest Kindle package from this page.
- Unzip the whole archive into the Kindle's USB root directory
- Install Stardict dictionaries (optional)
- Copy Stardict format dictionary files (*.idx, *.ifo, *.dict) into the koreader/data/dict directory.
- Install Tesseract language data (optional)
- Copy Tesseract-OCR language data files (eng.*) for Tesseract 3.02 into the koreader/data/tessdata directory.
via KPV Booklet
Just open any book from the native system, all files except for mobi and txt will be opened with KOReader.
After installing KOReader, you will see related entries in the KUAL menu. Just tap on it :). The (no framework) variants will kill the native GUI first, and restart it once you've quit KOReader (the goal being to gain some more free RAM). Note that said variant may not be completely functional on some model/FW combinations. It's mostly aimed at older devices.
NOTE: After a firmware update, you will most likely have to reinstall some stuff. Of particular importance to KOReader: KPVBooklet itself if you're using it, as well as KUAL itself if you're running the Booklet version. More generally, the JB Hotfix is the first thing to try, although current JB versions should ensure basic functionality makes it through.
NOTE: On some recent FW versions, KPVBooklet may be non-functional. You may also need a tweaked version of KUAL. Again, check MobileRead's Kindle Dev forum.
IMPORTANT NOTE: Switching your device to USBMS mode (by plugging it to a computer over USB) while KOReader is running is entirely unsupported, and risks crashing in fun and interesting ways, both KOReader, and possibly the Kindle's underlying system. Recent KOReader versions make an attempt at avoiding complete and utter mayhem, but it's still not recommended to try to test that theory ;). If you need to charge your device while KOReader is running, either do it with a charger, or switch your device to USBNet mode first.
Err, there are three Kindle packages to choose from, which do I pick?
They're indicative of the earliest device family the binaries support (and are optimized for). Ideally, you choose the one that most closely matcesh your actual device, in order to enjoy the best possible performance.
- Legacy: K2, DX, K3 (and all their variants).
- Kindle: K4, K5, PW1
- PW2: Everything else, starting from the PW2 (i.e., PW2, KV, KT2, PW3, KOA, KT3, KOA2).
If you're unsure of which exact model you have, or if those nicknames confuse you, please refer to this handy table ;).