MobileRead Forums - View Single Post - Kindle -- KOReader: a document reader for PDF, DJVU, EPUB, FB2, HTML, ... (GPLv3)

hawhill · 03-26-2013, 03:49 PM

Hi,

some of you may have come across the KindlePDFViewer (KPV) application in the past. Since a couple of month, we - the development team - tried to port its functionality over to touch based devices like the Kindle 5 (Touch) and the Kindle Paperwhite. The effort has now gotten far enough to warrant a first official release.

Since KindlePDFViewer got support for many more document formats than just PDF, that called for a new name. We settled on KOReader as the new name.

Moderator Notice

This thread was copied from its original home in the Kindle Developer's Corner, and has a wealth of (mostly disorganized

) accumulated information which is generally applicable to KOReader.

Please address any Kindle-specific questions (e.g. device integration, getting KOReader to run, anything where it matters that you are using a Kindle and not a Kobo/Pocketbook/Android) in the Kindle Developer's Corner.

This ensures that the Kindle experts can help you with Kindle-specific problems, and the KOReader experts can help you with KOReader-specific problems.

KOReader's features

supported document formats: PDF, DJVU, CBZ, FB2, TXT, HTML, RTF, CHM, MOBI, EPUB (and maybe even more?).
KUAL integration: The reader comes with configuration files for KUAL (and, which doesn't make much sense right now, also for launchpad - but there is only support for touch input so far in the application).
alternatively, you can use KPV Booklet to launch KOReader
Open Source Software: you're invited to help us and start hacking on KOReader! The frontend is coded in Lua, so you need only an editor to get going.

Installation

install KUAL (https://www.mobileread.com/forums/sho...d.php?t=203326) or KPV Booklet (not sure if there's a matching release already, this post will be updated soon)
download a current nightly or release build, which should be linked to from here: http://github.com/koreader/koreader/wiki/Download
copy the ZIP's contents (so: extract it!) to the root folder (in drive mode, it's /mnt/us internally) of your Kindle

Current limitations

KOReader is still in an early stage. You will notice some inconveniences, some incoherences in the user interface and maybe even a bug here and there. Feel free to ask questions in this thread and report bugs in our issue tracker (link at the bottom of this posting). Documentation is lacking. Help is welcome!

There is currently no support for pure keyboard-based devices. For those, you're encouraged to have a look at the stable version - KindlePDFViewer. An alternative, especially for the Kindle 4 (NT) is Librerator, a fork of KindlePDFViewer.

However, it is already usable - so feel free to give it a try. And of course, expect updates, so come back and check this post from time to time.

Links

All releases and nightlies are linked here: http://github.com/koreader/koreader/wiki/Download

The wiki page with install & usage instructions is here: https://github.com/koreader/koreader...der-User-Guide

You can find the source code here: https://github.com/koreader/koreader
Please report bugs here: https://github.com/koreader/koreader/issues

The source code of KPV Booklet is available here: https://github.com/koreader/kpvbooklet

Legacy, stable code for keyboard-based devices (K2, KDX, K3): KindlePDFViewer - https://www.mobileread.com/forums/sho...d.php?t=157047

Forked version, especially for the K4 (NT), but also for other keyboard-based devices: Librerator - https://www.mobileread.com/forums/sho...d.php?t=198742

03-26-2013, 03:49 PM	#1
hawhill Wizard Posts: 1,379 Karma: 2155307 Join Date: Nov 2010 Location: Goettingen, Germany Device: Kindle Paperwhite, Kobo Mini	Kindle -- KOReader: a document reader for PDF, DJVU, EPUB, FB2, HTML, ... (GPLv3) Hi, some of you may have come across the KindlePDFViewer (KPV) application in the past. Since a couple of month, we - the development team - tried to port its functionality over to touch based devices like the Kindle 5 (Touch) and the Kindle Paperwhite. The effort has now gotten far enough to warrant a first official release. Since KindlePDFViewer got support for many more document formats than just PDF, that called for a new name. We settled on KOReader as the new name. Moderator Notice This thread was copied from its original home in the Kindle Developer's Corner, and has a wealth of (mostly disorganized ) accumulated information which is generally applicable to KOReader. Please address any Kindle-specific questions (e.g. device integration, getting KOReader to run, anything where it matters that you are using a Kindle and not a Kobo/Pocketbook/Android) in the Kindle Developer's Corner. This ensures that the Kindle experts can help you with Kindle-specific problems, and the KOReader experts can help you with KOReader-specific problems. KOReader's features supported document formats: PDF, DJVU, CBZ, FB2, TXT, HTML, RTF, CHM, MOBI, EPUB (and maybe even more?). KUAL integration: The reader comes with configuration files for KUAL (and, which doesn't make much sense right now, also for launchpad - but there is only support for touch input so far in the application). alternatively, you can use KPV Booklet to launch KOReader Open Source Software: you're invited to help us and start hacking on KOReader! The frontend is coded in Lua, so you need only an editor to get going. Installation install KUAL (https://www.mobileread.com/forums/sho...d.php?t=203326) or KPV Booklet (not sure if there's a matching release already, this post will be updated soon) download a current nightly or release build, which should be linked to from here: http://github.com/koreader/koreader/wiki/Download copy the ZIP's contents (so: extract it!) to the root folder (in drive mode, it's /mnt/us internally) of your Kindle Current limitations KOReader is still in an early stage. You will notice some inconveniences, some incoherences in the user interface and maybe even a bug here and there. Feel free to ask questions in this thread and report bugs in our issue tracker (link at the bottom of this posting). Documentation is lacking. Help is welcome! There is currently no support for pure keyboard-based devices. For those, you're encouraged to have a look at the stable version - KindlePDFViewer. An alternative, especially for the Kindle 4 (NT) is Librerator, a fork of KindlePDFViewer. However, it is already usable - so feel free to give it a try. And of course, expect updates, so come back and check this post from time to time. Links All releases and nightlies are linked here: http://github.com/koreader/koreader/wiki/Download The wiki page with install & usage instructions is here: https://github.com/koreader/koreader...der-User-Guide You can find the source code here: https://github.com/koreader/koreader Please report bugs here: https://github.com/koreader/koreader/issues The source code of KPV Booklet is available here: https://github.com/koreader/kpvbooklet Legacy, stable code for keyboard-based devices (K2, KDX, K3): KindlePDFViewer - https://www.mobileread.com/forums/sho...d.php?t=157047 Forked version, especially for the K4 (NT), but also for other keyboard-based devices: Librerator - https://www.mobileread.com/forums/sho...d.php?t=198742 Last edited by eschwartz; 02-11-2016 at 02:55 PM.