Add-on:EBooks: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
m (Addon-Bot Update)
Line 3: Line 3:
|extension point=xbmc.python.pluginsource
|extension point=xbmc.python.pluginsource

Revision as of 20:29, 7 June 2016


Author: robwebset

Type: Program

License: GPL v2.0
Source: Source code
Summary: View eBooks
Home icon grey.png   ▶ Add-ons ▶ eBooks
Attention talk.png Need help with this add-on? See here.

Allows the viewing of eBooks


eBooks is an addon that allows you to list and view your epub and mobi eBooks using Kodi. Only the text will be displayed, no images.

Supported book formats are

  • ePub
  • Mobi
  • PDF

On installation of the eBook addon it will need configuring to point to the directory that contains all of your eBook files. This can be done via the eBooks Settings, or if not set, you will be prompted on first use.

Book Listing

When entering the addon via the Programs Menu the available books will be listed in the format:

Author - Title

Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting a book, the chapters in that book will be displayed (Note: If there are no chapters, then a single entry for the entire book will be displayed).

Any books or chapters that have been marked previously as read will start with an asterisk ("*").

Text Viewer

When a chapter is selected for reading it will be displayed in the text viewer. This enables the reader to scroll down the text either using the scrollbar or up and down arrow keys. Once the chapter has been read the user can either

  • Select "Close" to close the window
  • Select "Mark As Read" to record that this chapter has been read and then close the window
  • Select "<" (Or the Page Up key) to go back to the previous chapter
  • Select ">" (Or the Page Down key) to go to the next chapter

Cover Art

The cover art for a given book is retrieved in the following order:

  1. A jpg file in the same directory as the book with the same name (i.e. a book with the name mybook.epub and an image with the name mybook.jpg)
  2. An image that has previously been cached from a book (Based on the file name of the book)
  3. Extracted internal image from the book file
  4. The default cover image set in the eBooks settings screen.

OPDS Support

The eBooks addon supports the OPDS network protocol that enables you to expost your eBooks over the network from a server. For information on how to set this up on your Calibre installation, a brief description can be found here.

This is the fastest way to navigate your library, especially if you wish to do so over a network connection. It also allows different filtering methods rather than a directory based navigation.

Network Support

If you store your books on a network server and use Kodi to access them via smb:// or nfs:// then the initial listing of the available books will be slower (Until they are cached into the eBooks database) and chapter listings and viewing will always be slower.

Why? - Because the ebook reading scripts are not able to read the smb:// or nfs:// format that Kodi uses, so in order for the addon to read the file, it is copied to a temporary local directory, it is this copy that makes the processing of data slower.

How to Avoid This? - Either store the books locally or use the OS level network functionality to map the drive in such a way that it looks like a local drive. The use of the OPDS interface will also supply a faster and cleaner navigation experience (Although the book will still need to be copied locally when it comes time to read it)



Use eBooks Folder
If eBooks are to be read from a directory location
- eBooks Folder
The Location where the eBooks are stored
OPDS Interface
If eBooks are to be read from an OPDS server
The URL and port of the OPDS server (e.g. localhost:8080)
Default Book Cover Image
The default cover image to use if there is no image available for the book
Only Show Whole Book If No Chapters
Will only show a link to the entire book if there are no chapters available in the book
Mark Chapter As Read When Navigating To Next Chapter
When using the next button on the viewer, mark the chapter being left as read
Use White Background For Reader
Use black text on a white background for the viewer window
Always Use Page Numbers For PDF Files
When listing PDF files, use page numbers rather than any chapters found


Clean Book Cover Cache
Removes any book covers that have been cached
Clear Book Details Cache
Clears any data cached about the ebooks (inc. read markers)
Enable debug logging
Enables eBooks debug logging (Required if reporting a problem) - for this to work, system-wide Kodi logging must also be enabled


If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:

  • Kodi logging from the main setting menu
  • eBooks debug from the eBooks addon settings menu

Please do not paste the log into the forum thread, just link to it.


If you have found the eBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.

Please use the link on the top of the eBooks Forum