Skip to content
A PDF (plus DJVU, ePub, TXT, CHM, FB2, HTML...) viewer made for e-ink framebuffer devices, using muPDF, djvulibre, crengine
Lua C C++ Shell
Pull request Compare This branch is 101 commits behind koreader:master.
Latest commit d87b028 Jan 15, 2013 @tigran123 tigran123 Merge pull request #716 from houqp/master
bug fix for crereader's toc
Failed to load latest commit information.
djvulibre @ 01a26be
include
kite New InfoMessage Concept Oct 3, 2012
kpvcrlib
launchpad
libk2pdfopt @ f31e2a8
luafilesystem @ 149e0fb
luajit-2.0 @ eb6f890
mupdf @ 05219d0
popen-noshell
resources
test
utils
.gitignore
.gitmodules
COPYING
Makefile
README.md
battery.lua
blitbuffer.c
blitbuffer.h
commands.lua
cre.cpp
cre.h
crereader.lua bug fix: handle page mode in redrawCurrentPage Jan 13, 2013
defaults.lua change default view mode to page mode Dec 13, 2012
dialog.lua
djvu.c
djvu.h
djvureader.lua
drawcontext.c
drawcontext.h
einkfb.c
einkfb.h
extr.c
filechooser.lua
filehistory.lua
fileinfo.lua
filesearcher.lua
font.lua
ft.c
ft.h
graphics.lua
helppage.lua
image.lua
input.c
input.h
inputbox.lua
keys.lua
koptconfig.lua
koptcontext.c
koptcontext.h
koptreader.lua
kpdf.sh
kpdfview.c
mupdf.patch
mupdfimg.c
mupdfimg.h
pdf.c
pdf.h
pdfreader.lua
pic.c
pic.h
pic_jpeg.c
pic_jpeg.h
picviewer.lua
reader.lua
readerchooser.lua
rendertext.lua
screen.lua
selectmenu.lua Merge pull request #484 from tigran123/selectmenu-jump Oct 23, 2012
settings.lua
slider_watcher.c
unireader.lua
util.c
util.h
widget.lua

README.md

KindlePDFViewer

This is a document viewer application, created for usage on the Kindle e-ink reader. It is currently restricted to 4bpp inverse grayscale displays. For PDF files it is using the muPDF library (see http://mupdf.com/), for DjVu files djvulibre library and for ebooks (fb2, mobi, ePub, etc) crengine. It can also read JPEG images using libjpeg library. The user interface is scripted using Lua (see http://www.lua.org/).

The application is licensed under the GPLv3 (see COPYING file).

Building

Follow these steps:

  • fetch thirdparty sources

    • manually fetch all the thirdparty sources:

      • install muPDF sources into subfolder "mupdf"
      • install muPDF third-party sources (see muPDF homepage) into a new subfolder "mupdf/thirdparty"
      • install libDjvuLibre sources into subfolder "djvulibre"
      • install CREngine sources into subfolder "kpvcrlib/crengine"
      • install LuaJit sources into subfolder "luajit-2.0"
      • install popen_noshell sources into subfolder "popen-noshell"
    • automatically fetch thirdparty sources with Makefile:

      • make sure you have patch, wget, unzip, git and svn installed
      • run make fetchthirdparty.
  • adapt Makefile to your needs

  • run make thirdparty. This will build MuPDF (plus the libraries it depends on), libDjvuLibre, CREngine and Lua.

  • run make. This will build the kpdfview application

Running

The user interface (or what's there yet) is scripted in Lua. See "reader.lua". It uses the Linux feature to run scripts by using a corresponding line at its start.

So you might just call that script. Note that the script and the kpdfview binary currently must be in the same directory.

You would then just call reader.lua, giving the document file path, or any directory path, as its first argument. Run reader.lua without arguments to see usage notes. The reader.lua script can also show a file chooser: it will do this when you call it with a directory (instead of a file) as first argument.

Device emulation

The code also features a device emulation. You need SDL headers and library for this. It allows to develop on a standard PC and saves precious development time. It might also compose the most unfriendly desktop PDF reader, depending on your view.

If you are using Fedora Core Linux, do yum install SDL SDL-devel. If you are using Ubuntu, install libsdl-dev1.2 package.

To build in "emulation mode", you need to run make like this: make clean cleanthirdparty EMULATE_READER=1 make thirdparty kpdfview

And run the emulator like this:

./reader.lua /PATH/TO/PDF.pdf

or:

./reader.lua /ANY/PATH

By default emulation will provide DXG resolution of 824*1200. It can be specified at compile time, this is example for Kindle 3:

EMULATE_READER_W=600 EMULATE_READER_H=800 EMULATE_READER=1 make kpdfview
Something went wrong with that request. Please try again.