KOBO

KINDLE

POCKETBOOK

REMARKABLE

CERVANTES

ANDROID
LINUX

KOREADER USER GUIDE

 This guide includes topics regarding the usage and customization of KOReader.
Since it is optimized for larger color screens and contains links to related websites, we
recommend reading this document on a computer or tablet.

If this is your first time using KOReader, we recommend learning about the USER
INTERFACE first, to familiarize yourself with the application. Guide is mainly organized as
questions which explain basic usage of the application from a new user’s perspective.
Suggested method is, opening this manual on a computer and trying the explained
actions on your e-reader. You can also use the search function of your PDF reader.

KOReader is developed and supported by volunteers all around the world.

There are many ways you can be a part of the project. You can:
- Fix bugs and implement new features
- Translate the program into your language or improve an existing translation
- Document lesser-known features on the wiki
- Help others with your knowledge in the forum

Check MORE INFO section for links.

KOReader User Guide · 1

 TABLE OF CONTENTS

USER INTERFACE
User interface tips
Interface is too big / small. How can I change the scale ?
Can I disable black flashing of items in the interface ?
Explanation of menu items

GENERAL READING INFO

How can I personalize text ?
How can I add my own fonts ?
How can I export my highlights ?
How can I configure status bar ?
How can I move through my document ?

READING PDFS
How can I read a big PDF document ?
Explanation of PDF specific menu items
OCR (Optical Character Recognition)
Panel Zoom (manga/comic)

DEVICE
How can I transfer books, articles to my device ?
How can I control backlight / frontlight of my screen ?
How can I change the screen displayed while sleeping ?
How can I see my battery consumption details ?
How can I see my system statistics ?

KOReader
How can I install dictionaries ?
How can I update KOReader ?

GESTURES

PLUGINS

TIPS AND TROUBLESHOOTING

MORE INFO

KOReader User Guide · 2

 USER INTERFACE
Let’s first get familiar with the interface because we will be referring to these interface items through the guide.
KOReader has 2 main interfaces: READING SCREEN and FILE BROWSER

READING SCREEN has two toolbars. TOP BAR includes menu

items related to general usage of KOReader. You will access
your books, KOReader preferences, plugins etc. here.

Bottom bar is focused on options for document formatting like

font weight/size, line spacing etc. While reading you will
probably interact mostly with the BOTTOM BAR.

To show the TOP BAR or BOTTOM BAR you can click the
indicated zones.

You can click or swipe down the upper zone to show the TOP
MENU.

You can also set TOP MENU zone to show both TOP and
BOTTOM BARs at the same time via this menu:

TOP BAR > > Taps and Gestures > Activate Menu

CORNER TAP ZONES can be used for many different type of

gestures including TAP, DOUBLE TAP, TWO FINGER TAP and
TAP and HOLD.

PREVIOUS PAGE and NEXT PAGE zones can be used for

DOUBLE TAP gestures at the same time.

STATUS BAR zone can be used to cycle between STATUS

BAR items if one item is visible. If all items are visible, it will
show and hide STATUS BAR. Check How can I configure
status bar ? section for more info.

KOReader User Guide · 3

 FILE BROWSER is the first screen you will see when you open
KOReader. It is also accessible from reading screen via:

TOP BAR >

By default, it shows your main books folder (which you can

change by tapping and holding on any folder).

You can change many options like how books are displayed or
sorted via TOP MENU by swiping down from the top part of
screen as shown in the image on the left.

When you tap and hold a document, a dialog with many

options is shown. Most items are self-explanatory. Items which
are circled explained below:

PURGE .SDR: This option basically resets your book by

deleting its configuration/highlights file. Use with caution !

IGNORE COVER: If for some reason you want to disable the

cover for this book (wrong cover or invisible on e-ink screen)
you can select this.

IGNORE METADATA: If your book metadata is not correct,

name field may show useless information. Select this option to
show the file name instead of metadata.

Following methods are available for accessing your books and articles:
- File Browser
- Favorites
- History

You can assign gestures for each of these dialogs. For example while reading a book, you can open your History
or Favorites with a gesture to open another book without going through File Browser.

You can also set KOReader to open with any of these dialogs on startup via:

TOP BAR (in File Browser) > > Start with

KOReader User Guide · 4

 USER INTERFACE TIPS
Please familiarize yourself with these actions. They will make interacting with KOReader easier.
- You can change interface language via:

TOP BAR > > Language

- Be aware that KOReader has different support and UI for fixed layout documents (PDF, DJVU, images...) and
reflowable documents (EPUB, HTML, DOCX, RTF, TXT…).
- If you tap and hold an option or menu item (font weight, line spacing etc.), you can set its value as DEFAULT.
The new value will only be applied to documents opened from now on. Previously opened documents will keep
their settings. You can identify default values as a STAR in menu or as a black border around indicators as seen
below:

- You can see explanations for all items on the BOTTOM BAR by tapping and holding the option’s name
- You can CLOSE full screen dialogs (History, Table of Contents, Bookmarks, Reading Statistics etc.) by swiping
down
- Screenshots can be taken by touching opposing corners of the screen diagonally at the same time or by making
a long diagonal swipe

- In dialogs containing adjustment arrow buttons like the one on the right, you
can tap and hold on arrow buttons to increase / decrease the value in bigger
increments
- You can CLOSE this type of dialog (non-full screen) by tapping outside of the
window
- You can MOVE this type of dialog by holding the window title and dragging
- You can make this type of dialog SEMI-TRANSPARENT (to see the text under it
while adjusting a value) by tapping and holding the window title

- KOReader supports dictionary lookup in EPUB and even in scanned PDF/DJVU documents. To see the dictionary
definition or translation, tap and hold a word.
- Tapping and holding a word brings up a dialog where you can also search the selection in the document for
more occurrences or look it up on Wikipedia
- You can highlight sections by tapping and holding a word and dragging the finger. If you reach page boundaries,
KOReader will turn the page for you to continue highlighting (works only in EPUB/HTML documents). You can
adjust highlighting options via:

TOP BAR > > Highlighting

KOReader User Guide · 5

Interface is too big / small. How can I change the scale ?
There is a DPI setting that controls size of interface:

TOP BAR > > Screen > Screen DPI

You can choose a value from the menu or select CUSTOM DPI to enter a number yourself for fine tuning.
Higher DPI = Bigger Interface

Note that there is also a Zoom (dpi) setting in the bottom bar. That one is related to documents only. You can find
the explanation below.

Can I disable black flashing of items in the interface ?

Yes you can adjust flashing via this menu:

TOP BAR > > Screen > E-ink Settings

EXPLANATION OF MENU ITEMS

In this section you can find explanations for KOReader features. Self-explanatory items are skipped.

BOTTOM BAR >

VIEW MODE: In continuous mode you can scroll the
document like a web page. This mode is more suitable
for non e-ink screen types (LCD, OLED). In continuous
mode you lose TOP - BOTTOM MARGINS so text may
be cut on first and last line of screen. To solve this
problem you can enable PAGE OVERLAP

TOP BAR > > Page Overlap

RENDER MODE: This determines how your document is

rendered by KOReader, default is WEB and generally you
don’t need to change this setting. When a book (or saved
web page) is complicated (specified widths or margins,
negative margins, floats) and things look bad or
overflowing the screen, other rendering modes may give
better results.

ZOOM (dpi): This setting can be thought of as a general

zoom factor for the document (except font size). At 96
dpi (which is the default setting), images in the document
are rendered at their original dimensions. You can use
this setting if you want to make images bigger without
making text bigger.

KOReader User Guide · 6

BOTTOM BAR >
WORD SPACING and WORD EXPANSION: These two
settings are related and they determine how your text
will look when it is justified (left and right side of the text
is flush to margins). Since word counts of lines are not
equal, in justified alignment text has to be compressed or
expanded to fill the line.

WORD SPACING: How much the SPACE characters in a

line of text can be compressed to fit more words. This
setting doesn’t affect words, it only changes the space
between them.

WORD EXPANSION: If you have too much white space

in a line, how much of that can be distributed into the
words by expanding them. This setting affects the
appearance of words. If you don’t want your words to
expand, set this to NONE.

You can experiment with different settings until the text

looks pleasing to you, then set them as defaults via their
respective dialogs.

BOTTOM BAR >

FONT HINTING adjusts text for maximum readability
according to screen’s pixel grid. NATIVE uses font’s
internal hinting instructions, AUTO uses FreeType’s
hinting algorithm. AUTO is a safer choice because font
files that you installed may have problematic hinting
instructions. It also handles CJK text better. You can try
different settings to see which one looks better on your
device.

FONT KERNING adjusts the spacing between letters to

achieve a visually pleasing result. Default is BEST, which
might be slower when opening files (depending on your
device) but has better support for ligatures (see picture
on the left for an example), joined Arabic glyphs and
some other scripts. If your device is slow, you can try
GOOD which is faster and may still look correct with
western latin-script text.

CONTRAST and FONT WEIGHT are two options that you can use to make your text bolder (or lighter). You can
achieve the same appearance with either of these options but they use different methods to achieve it. Of course
you can use them both at the same time.

KOReader User Guide · 7

The differences between them can be summarized like this:
CONTRAST FONT WEIGHT
+ Doesn’t change font width, book length stays same + Will use proper weighted fonts if you have them installed
+ Doesn’t need to re-render document, faster + Looks better on LCD or low DPI screens
- Might look bad on LCD or low DPI screens. - Has to re-render fonts, slower

BOTTOM BAR >

ALT STATUS BAR enables or disables an alternative
status bar which is available only in reflowable
documents (EPUB, HTML, DOCX, RTF, TXT…). After
enabling it here you can configure ALT STATUS BAR via:

TOP BAR > > Status Bar > Alt status bar

EMBEDDED STYLE and EMBEDDED FONTS determine

if publisher styles and fonts embedded in the document
will be used to render the document. These are general
on/off switches. You can achieve more fine tuned tweaks
for your document via:

TOP BAR > > Style Tweaks

IMAGE SCALING determines how images in your

document are rendered. BEST is more pleasing but
slower.

KOReader User Guide · 8

 GENERAL READING INFO

How can I personalize text ?

- You can change the font* TOP BAR > > Font
- Make font bigger BOTTOM BAR >
- Make font bolder BOTTOM BAR >
- Invert the colors on screen (white on black) TOP BAR > > Night Mode
- Change many other formatting options* TOP BAR > > Style Tweaks

* Font selection and style tweaks are available only on reflowable documents (EPUB, HTML, DOCX, RTF, TXT…).
Fixed-layout documents like PDF/DJVU are not supported.

- You can also change other formatting options from BOTTOM BAR to fine tune the appearance of your text.

You can see your reading statistics via:

TOP BAR > > Reading Statistics

How can I add my own fonts ?

KOReader supports fonts in most widely used TrueType (.ttf) and OpenType formats (.otf). Font files with these
extensions can be directly copied to /koreader/fonts/ folder on your device. Check the wiki for more info:
https://github.com/koreader/koreader/wiki/Fonts

When starting up, KOReader compiles the available fonts from the font metadata/info and classifies them
according to family and weights. This means you can add different weights and variants of a font and KOReader
will try to use the most suitable one. Since it is taking font family information from metadata, font names are not
important when copying to your device. Installed fonts will be available after restarting KOReader. Refer to the
previous question for how to change the font.

You can check the Google Fonts website for more fonts: https://fonts.google.com

How can I export my highlights ?

There are different ways of exporting your highlights from your reader:
1. You can use the EVERNOTE plugin to export your notes as local TXT, HTML or JSON files on your device or
export them directly into Joplin over a network (a note taking application, you can find HELP under JOPLIN menu
in EVERNOTE plugin - https://joplinapp.org/):

TOP BAR > > Evernote

2. You can use an external program named KoHighlights. It can access your book notes when you plug your
reader to your computer. https://github.com/noembryo/KoHighlights

KOReader User Guide · 9

3. If you are using Calibre, you can import highlights into your database with KOReader Sync plugin. You can
install mentioned plugin within Calibre.

NOTE: When you open a document in KOReader, it creates a directory alongside the document with same name
as the document. This directory contains a .LUA file which includes all the highlights and user options (formatting
properties etc.) related to that document. You can manually backup/restore these directories.

How can I configure status bar ?

You can configure bottom status bar from via this menu:

TOP BAR > > Status Bar

There are many items you can show on the status bar. But by default, only one is shown at a time and you have to
click on the status bar to cycle between them. If you want to show all items at once, enable this menu item:

TOP BAR > > Status Bar > Settings > Show all at once

You can sort the items via: TOP BAR > > Status Bar > Settings > Sort items

Feel free to explore the SETTINGS sub-menu mentioned above to customize your status bar as you like.

There is also an ALT STATUS BAR which is available in reflowable documents (EPUB, HTML, DOCX, RTF, TXT…). If
you prefer, you can enable this via:

BOTTOM BAR > > Alt Status Bar

You can configure ALT STATUS BAR via: TOP BAR > > Status Bar > Alt status bar

How can I move through my document ?

Via SKIM DOCUMENT dialog. You can assign this dialog to a gesture for quick access.

TOP BAR > > Skim document

KOReader User Guide · 10

CHAPTER MARKS
KOReader can show chapter boundaries from your
documents on your SKIM DOCUMENT DIALOG and
PROGRESS BAR.

If you have a document with too many heading levels,

your chapter marks can look crowded like the example
on the left. You can change the depth of visible ToC
mark levels via:

TOP BAR > > Settings > Progress Bars

You can also use this reduced ToC for chapter titles (if it
is shown in status bar), chapter navigation and “reading
time left” estimates. These options are in the same
menu.

If your document doesn’t have a Table of Contents, you

can enable ALTERNATIVE TABLE OF CONTENTS.
When this setting is enabled, KOReader will build a ToC
from document headings (if available) or from individual
HTML files in the EPUB. Long-tap the menu item for extra
info:

TOP BAR > > Settings > Alternative table of contents

KOReader User Guide · 11

 READING PDFS

My PDF/DJVU document’s page size is bigger than my screen.

How can I read a document like this on my smaller screen ?
There are many ways to read a PDF/DJVU document optimized for bigger (generally A4 or Letter) page sizes:

1. You can enable REFLOW from

BOTTOM BAR > > Reflow

Reflow tries to extract the text portion from your document (if it is available) and format it as a single column.
Results are generally satisfactory. You can also set this as DEFAULT by tapping and holding on it.

2. You can enable ZOOM TO CONTENT via this menu item you can see in the image above:

BOTTOM BAR > >

With this option KOReader tries to crop margins from your document so text may look bigger on your screen. You
can set FIT to WIDTH in the same menu which will try to fit only page width instead of whole page, so your text
will look bigger.

3. Also you can try to use your device in LANDSCAPE orientation. This will make your screen wider so your
document may look big enough to read comfortably:

BOTTOM BAR >

4. If you wish you can see your document at full size and scroll to read different parts. This is especially helpful
with comic books.
First enable COLUMN MODE from this menu item:

BOTTOM BAR > >

Then select an appropriate flow direction for your document from the same menu:

KOReader User Guide · 12

- For example if you are reading an article which has two columns, you will scroll down until the end of page

reading left column then go to right upper side to continue reading right column:

- Or if you are reading a comic book, you will go right-left down-right in a zigzag pattern:

- For a Japanese comic book (right-to-left panel order) this might be the reverse:

In this mode you can also adjust Horizontal / Vertical Overlap and Number of Columns from the same menu to
fit text on your screen better. Feel free to experiment with settings.

EXPLANATION OF PDF SPECIFIC MENU ITEMS

BOTTOM BAR >

CONTRAST This setting adjusts black levels in your
document. Be aware that same contrast value applies to
both text and images in your document. If you set it very
high, your images may become too dark to be readable.

DEWATERMARK Removes watermarks from the

rendered document. It can also be used to remove gray
backgrounds. This feature can convert a grayscale or
color document to black & white to produce more
contrast for easier reading.

RENDER QUALITY (REFLOW MODE) Sets the quality of

text and image extraction processing and output. HIGH
is more pleasing but it can be much slower (several
seconds for page turn) than DEFAULT depending on
your document. If your PDF/DJVU files are slow, this is
the first setting you should check.

BOTTOM BAR >

DOCUMENT LANGUAGE Sets the language to be used
by the OCR engine.

FORCED OCR Force the use of OCR even if the

document has a text layer

WRITING DIRECTION (REFLOW MODE) Text direction

of original document. Set to RTL for languages like
Arabic and Hebrew.

DOCUMENT COLUMNS (REFLOW MODE) Number of

text columns in the original document.

KOReader User Guide · 13

OCR (Optical Character Recognition)
OCR (Optical Character Recognition) is the process of extracting text from images into machine readable format.
In KOReader context, it is generally used for extracting text from scanned book pages in PDF files. KOReader relies
on Tesseract Open Source OCR Engine for this task (https://github.com/tesseract-ocr/tessdoc).

In order to use this feature you need to:

1. Install Tesseract language data to your KOReader
2. Add newly installed languages to koreader/defaults.lua configuration file
(necessary only if your language is other than English or Chinese)

NOTE: Buttons on OCR menu has no function until you install necessary Tesseract files.

Details of this process can be read in the related wiki page:

https://github.com/koreader/koreader/wiki/Dictionary-support#dictionary-lookups-in-scanned-pages

Panel Zoom (manga/comic)

This feature makes reading comic books easier on smaller screens. You can enable it while you are reading a
PDF/DJVU document via:

TOP BAR > > Panel Zoom (manga/comic)

When this option is enabled, KOReader tries to find the boundaries of rectangular panels on the screen. If you
long-tap on a panel, KOReader zooms in to that panel. As you can guess, this feature works best with comics that
has clean panel boundaries. Procedure can be seen below:

KOReader User Guide · 14

 DEVICE

How can I transfer books, articles to my device ?

KOReader supports PDF, EPUB, DJVU, MOBI, CBZ, CBR, DOCX, RTF, HTML, TXT, XPS, FB2, PDB, CHM and ZIP
files.

KOReader can reflow PDF documents (this option can be found in the bottom menu while reading a fixed-layout
document like PDF) to make them suitable for the small screens of e-readers. But for best results, you may want to
convert your documents into more flexible EPUB format. You can use Calibre (https://calibre-ebook.com/) for all
kinds of conversion between formats.

There are many ways to transfer your documents to your device. Note that you may need to restart KOReader to
index the transferred documents (or refresh directory if you have Pocketbook/Android).

In addition to transferring files the same way you would with the built-in reader application, other options are
available depending on your device:

1. USB Mass Storage mode within KOReader: This mode is available for KOBO and some CERVANTES devices.

2. Cloud storage (Dropbox/FTP/Webdav): To use this function you have to add accounts for a cloud storage
server via menu shown below. Process is explained via INFO buttons while adding accounts:

TOP BAR (in File Browser) > > Cloud storage

3. SSH/SFTP access: KOReader can act like an SSH server, which you can access from a computer to transfer
files. You can use an SFTP application (like Filezilla) or access via your file manager if your operating system
supports. Check wiki for how-to: https://github.com/koreader/koreader/wiki/SSH

4. Calibre transfer: With the Calibre plugin you can send documents from your Calibre Library directly to your
KOReader devices via a wifi connection. Check wiki for how-to: https://github.com/koreader/koreader/wiki/Calibre-
wireless-connection

5. News downloader: With this plugin you can download RSS and Atom news entries tas HTML files. Check wiki
for how-to: https://github.com/koreader/koreader/wiki/News-downloader

6. Wallabag: With this plugin you can retrieve articles from WALLABAG, a server based read-it-later service like
Pocket. Check wiki page for more info: https://github.com/koreader/koreader/wiki/Wallabag

KOReader User Guide · 15

How can I control the backlight / frontlight of my screen ?
You can control your screen light via this menu. If you have warm lighting (normal white LEDs+orange ones) you
can control them separately from this dialog. You can also define a gesture for this dialog:

TOP BAR > > Frontlight

How can I change the screen displayed while sleeping ?

You can choose a book cover or a custom image as screensaver via this menu:

TOP BAR > > Screen > Screensaver

You can use JPG/PNG files as screensaver (properly dithered grayscale images look best). Transfer the files from
your computer into any folder on your device. And choose this folder as your screensaver folder via this menu:

TOP BAR > > Screen > Screensaver > Settings

Refer to this forum post for advanced information about screensaver images:
https://www.mobileread.com/forums/showpost.php?p=3728291&postcount=17

How can I see my battery consumption details ?

You can see your detailed battery usage statistics via this menu item:

TOP BAR > > More Tools > Battery Statistics

How can I see my system statistics ?

You can see your system information like CPU / DISK SPACE / RAM usage via this menu item:

TOP BAR > > Help > System statistics

KOReader User Guide · 16

 KOReader

How can I install dictionaries ?

To use the dictionary lookup function, first you need to install one or more dictionaries in the StarDict format.
KOReader has an inbuilt dictionary installation system:

TOP BAR > > Dictionary Settings > Download dictionaries

Your downloaded dictionary will be available when you tap and hold a word in your document.

A list of freely available dictionaries can be found on the Firedict site:

https://tuxor1337.frama.io/firedict/dictionaries.html

For details about install procedure you can check the related GitHub wiki page:
https://github.com/koreader/koreader/wiki/Dictionary-support

How can I update KOReader ?

KOReader can update itself over Wi-Fi. Trigger the check via this menu item:

TOP BAR > > Update > Check for update

If there is an update available, a dialog will be shown. After confirming the update, KOReader will download
necessary files and restart itself.

KOReader User Guide · 17

 GESTURES
These are types of gestures you can use to control KOReader. Some gestures have limitations regarding where
they can be used on the screen and which directions are supported. These limitations are indicated below.

Note that some devices support only single touch. So multi-finger gestures are not available on them.

Cardinal directions Diagonal directions

Single or double tap with ONE finger

TAP / DOUBLE TAP
- Anywhere on screen

Single tap and hold with ONE finger

TAP AND HOLD
- Only on four corners

Single tap with TWO fingers at the same time

TWO FINGER TAP
- Only on four corners

Swiping motion with ONE finger

ONE FINGER SWIPE - Screen edges
- Anywhere except edges

Swiping motion with TWO fingers at the same time

TWO FINGER SWIPE
- Anywhere on screen

More than one swipe done after each other without lifting your
finger. For example like drawing the letter U =DOWN-RIGHT-
MULTISWIPE
UP
- Anywhere on screen

Same gesture as zooming in and out on a mobile phone, tablet

etc.
- Anywhere on screen
SPREAD AND PINCH
NOTE: This gesture may work less reliably depending on your
device. If that’s the case please choose another gesture type.

Icons by Econceptive from the Noun Project

KOReader User Guide · 18

 GESTURES REFERENCE SHEET

Gesture Manager doesn’t have an overall view for all defined gestures. Especially if you have many
gestures defined, situation can become confusing. You can print this page and write down your gestures
as a reference.

Spread Pinch

TAP CORNER HOLD CORNER

Top Left Corner Top Left Corner

Top Right Corner Top Right Corner

Bottom Left Corner Bottom Left Corner

Bottom Right Corner Bottom Right Corner

TWO FINGER TAP CORNER

Top Left Corner Top Right Corner

Bottom Left Corner Bottom Right Corner

DOUBLE TAP
Left Side Right Side

Top Left Top Right

Bottom Left Bottom Right

ONE FINGER SWIPE

Top Edge Top Edge

Left Edge Right Edge

Left Edge Right Edge

Bottom Edge Bottom Edge

TWO FINGER SWIPE

MULTISWIPE

KOReader User Guide · 19

 PLUGINS
Plugins are small applets that add various functions to your KOReader. You can enable/disable them via:

TOP BAR > > More tools > Plugin management

Auto frontlight Automatically turns the frontlight on and off once brightness in the environment reaches a
certain level. (Only available on some Kindle models)

Autosuspend Suspend device after chosen period of inactivity

Autoturn Automatically turns the page after a set period of time.

Background Service to other plugins: allows tasks to run regularly in the background.
runner

Battery statistics Collects and displays battery usage statistics of your device.

Calibre With this plugin you can send documents from your Calibre Library directly to your
KOReader devices via Wifi connection. Check the wiki for how-to:
https://github.com/koreader/koreader/wiki/Calibre-wireless-connection

Cover browser Allows cover display modes for file browser and history.

Cover image Saves the cover image of the current book as a file

Evernote The bundled Evernote export plugin is designed to export highlights and notes added
from both native reader in Kindle and the KOReader itself to Evernote cloud. Currently
Evernote login is not working. But plugin can be used to export to local files.

Gestures Provide gesture support for KOReader

Keep alive Keeps the device awake to prevent automatic Wi-Fi disconnects

Move to archive Moves current document to archive folder

News Retrieves RSS and Atom news entries and saves them as HTML files. Check the wiki for
Downloader how-to: https://github.com/koreader/koreader/wiki/News-downloader

OPDS Allows you to download books from online catalogs

Perception Based on the idea of using peripheral vision to read more quickly. Check this YouTube
expander video to see how it works: How to Triple Your Reading Speed in 20 Minutes (Tim Ferriss)

Profiles Allows combining multiple settings to make switchable profiles

Progress sync This plugin can synchronize your reading progress through a document across different

KOReader User Guide · 20

 KOReader devices. Check the wiki for how-to:
https://github.com/koreader/koreader/wiki/Progress-sync

QR from Generates a QR code from clipboard content

clipboard

Read timer A countdown timer to display a message after a user defined time

Reading statistics Calculates reading sessions statistics and reading speed for use in chapter/book
remaining time estimations

Send to ebook This plugin downloads articles saved to an FTP server, using the Send2Ebook PC/Android
application. Check project page: https://github.com/mwoz123/send2ebook

SSH Allows access to your device over SSH protocol. You can access via FTP applications or
even your file manager if it supports. Check the wiki page for how-to:
https://github.com/koreader/koreader/wiki/SSH

System statistics You can see your system information like CPU / DISK SPACE / RAM usage via this plugin.

TOP BAR > > Help > System statistics

Terminal Executes simple Unix terminal commands and shows their output. Multiple commands
can be run at once, e.g. cd / && pwd

Text editor A basic text editor to create and edit plain text files

Time sync Synchronizes the device time with NTP servers

Tweak document This plugin allows tweaking settings of a document before it is loaded based on external
settings factors

Wallabag This plugin downloads the latest articles from a Wallabag server as individual EPUB files.
Check the wiki page for more info: https://github.com/koreader/koreader/wiki/Wallabag

Zsync With the Zsync plugin, multiple Koreader devices on the same Wifi network can transfer
documents directly to one another. Check wiki page for more info:
https://github.com/koreader/koreader/wiki/Zsync-transport

KOReader User Guide · 21

 TIPS AND TROUBLESHOOTING

TIPS

Optimizing your document for your mobile reader device

Most widely used applications for converting or optimizing your document for your mobile reading device are
Calibre (EPUB, Kindle focused) and K2pdfopt (PDF focused).

Calibre can convert your documents between many formats. It also has a built-in editor that allows you to edit e-
books (and fix problems) in the most popular e-book formats, EPUB and Kindle.
https://calibre-ebook.com/

K2pdfopt optimizes PDF/DJVU files for mobile e-readers and smartphones. It works well on multi-column
PDF/DJVU files and can re-flow text even on scanned PDF files. It can also be used as a general PDF
copying/cropping/re-sizing/OCR-ing manipulation tool.
https://www.willus.com/k2pdfopt/

SingleFile is a browser extension for Mozilla Firefox, Google Chrome and Microsoft Edge. This extension allows
saving a web page as a single .html file with all resources (images, stylesheets, scripts) embedded.
https://github.com/gildas-lormeau/SingleFile#install

Keep an eye on your memory usage

In older Kindle devices some of our users reported crashes due to limited memory. KOReader memory usage can
go up if you open many files in one session. Especially PDF’s increase this amount. You can add a memory
indicator to your STATUS BAR and restart KOReader if this value gets high, to avoid crashes or reboots.

TOP BAR > > Status Bar > KOReader memory usage

Also you can configure KOReader to restart automatically if memory usage reaches a threshold via:

TOP BAR > > Device > Device Status Alerts

Keyboard shortcuts

Virtual keyboard allows entering extra characters when you tap and hold a key. You can tap outside the input field
to close it. Tap the input field to show the keyboard again.

KOReader User Guide · 22

Additionally there are some shortcuts for easier text manipulation:
Backspace - deletes all characters from the cursor to the beginning of the line.
Left Arrow - moves the cursor to the beginning of the line.
Right Arrow→ - moves the cursor to the end of the line.

For more information about the virtual keyboard, you can check related wiki page:
https://github.com/koreader/koreader/wiki/Virtual-keyboard

TROUBLESHOOTING

My status bar disappeared

Probably you tapped on STATUS BAR touch zone (check USER INTERFACE section to see an overview of touch
zones) and hid your status bar. You can bring it back by tapping the same zone. Check “How can I configure
status bar ?” section to see details.

My PDF/DJVU files are slow

If you set your RENDER QUALITY to HIGH text will be more pleasing but it can be much slower (several seconds
for page turn) than DEFAULT depending on your document. If your PDF/DJVU files are slow, this is the first setting
you should check.

BOTTOM BAR > > Render Quality

KOReader User Guide · 23

 MORE INFO
- You can find other KOReader users on MobileRead forums
https://www.mobileread.com/forums/forumdisplay.php?f=276

- You can report problems by opening an issue on our GitHub page

https://github.com/koreader/koreader

- You can find us at Gitter chat

https://gitter.im/koreader/koreader

- You can support the project via Liberapay

https://liberapay.com/KOReader

KOReader User Guide · 24