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.



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 (http://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/wiki/KOReader-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 - http://www.mobileread.com/forums/sho...d.php?t=157047

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

FAQ

I installed the latest Nightly Build and it crashes!
You decide: Either invest time and get in contact with the developers to help debugging. But please check beforehand if this is already actively discussed. But then, you could also decide to not bother. Nightly Builds are untested almost by definition and there will always be some builds that don't work at all, don't work fully, etc. etc.
HOW DO I CHANGE THE FONT SIZE etc?


EDIT: Since more and more people are asking about this I have added these instructions here




Thanks! Let it get settled for a moment, I guess we'll have a flurry of updates in the coming days and weeks to really bring it in shape. It's still a bit rough around the edges. Still some work to do.

This is probably a good place to say big thanks to other contributors, first and foremost to @chrox and @houqp (Github names) who did awesome work to make this happen.
Okay mate. Undying admiration from our camp.
Finally it's there

We are also working on the user document for installation and usage etc.

BTW, @twobob I am thinking of using KUAL to do update, should we write anupdate script and call it in KUAL or does KUAL supports customupdate features like launchpad?
Since I dont know what the customupdate thingy is I am am going to say it doesnt.

But if you can point me to a spec on that it could well do in the future.

So. In précis, for now a script, in the future was could look to include the functionality - once I know what it is!
Launchpad's custumupdates macro was a simple script that
- checked the folder "customupdates" for any ZIP files
- if there were some, it would extract them to the /mnt/us (usb drive root) file system and delete the ZIP if successfully extracted

That allowed easy installation for apps - just drop a ZIP file in the "customupdates" folder, run the macro - done.

I guess such a thing could easily be made available for KUAL, too. Question is, however, if KUAL should be extended with such a script - I guess the discussion about that should go to the KUAL thread.
Agreed. Shutting up now. Noise ends here
Hooray! Can I just update the older nightlies from Chrox's repo with the new ones - is it a simple update like that?
And thanks!