Giters

cocoa-chen / FolioReader-Android

A Java ePub reader and parser framework for Android.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FolioReader logo

Build Status

FolioReader-Android is an ePub reader and parser framework written in Java.

Features

  • Custom Fonts
  • Custom Text Size
  • Themes / Day mode / Night mode
  • Text Highlighting
  • List / Edit / Delete Highlights
  • Handle Internal and External Links
  • Portrait / Landscape
  • Reading Time Left / Pages left
  • In-App Dictionary
  • Media Overlays (Sync text rendering with audio playback)
  • TTS - Text to Speech Support
  • Parse epub cover image
  • PDF support
  • Book Search
  • Add Notes to a Highlight
  • Better Documentation

Demo

Custom Fonts

Custom fonts

Day and Night Mode

Day night mode

Text Highlighting

Highlight

Media Overlays

Media Overlay

Gradle

Add following dependency to your app build.gradle

compile 'com.folioreader:folioreader:0.2.3'

Usage

To use FolioReader, you need to call FolioReaderActivity with following parameters:

  1. INTENT_EPUB_SOURCE_TYPE - your epub can come from raw or assets folder or from SD card. Use enum FolioActivity.EpubSourceType.
  2. INTENT_EPUB_SOURCE_PATH - assets/SD card path of the epub file or raw ID of epub file if epub file is in raw folder

Reading from assets folder

Intent intent = new Intent(HomeActivity.this, FolioActivity.class);
intent.putExtra(FolioActivity.INTENT_EPUB_SOURCE_TYPE, FolioActivity.EpubSourceType.ASSESTS);
intent.putExtra(FolioActivity.INTENT_EPUB_SOURCE_PATH, "epub/The Silver Chair.epub");
startActivity(intent);

Reading from raw folder of resources

Intent intent = new Intent(HomeActivity.this, FolioActivity.class);
intent.putExtra(FolioActivity.INTENT_EPUB_SOURCE_TYPE, FolioActivity.EpubSourceType.RAW);
intent.putExtra(FolioActivity.INTENT_EPUB_SOURCE_PATH, R.raw.adventures);
startActivity(intent);

For reading from SD card, just retrieve absolute path of epub file and pass that in INTENT_EPUB_SOURCE_PATH.

Credits

  1. SwipeLayout
  2. ORMLite
  3. SMIL parsing

Author

Heberti Almeida

Mahavir Jain

Donations

This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated. Thank you!

PayPal

License

FolioReaderKit is available under the BSD license. See the LICENSE file.

About

A Java ePub reader and parser framework for Android.

License:BSD 3-Clause "New" or "Revised" License

Languages

Language:Java 83.1%Language:JavaScript 15.5%Language:HTML 0.7%Language:CSS 0.7%