Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/folioreader/folioreader-android

A Java ePub reader and parser framework for Android.
https://github.com/folioreader/folioreader-android

android custom-fonts epub epub-reader highlight java night-mode

Last synced: 30 days ago
JSON representation

A Java ePub reader and parser framework for Android.

Host: GitHub
URL: https://github.com/folioreader/folioreader-android
Owner: FolioReader
License: bsd-3-clause
Created: 2015-04-07T16:25:03.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-10-10T13:26:47.000Z (about 1 year ago)
Last Synced: 2024-10-14T11:03:33.822Z (30 days ago)
Topics: android, custom-fonts, epub, epub-reader, highlight, java, night-mode
Language: JavaScript
Homepage:
Size: 102 MB
Stars: 2,252
Watchers: 80
Forks: 718
Open Issues: 268
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License.md

Awesome Lists containing this project

README

        ![FolioReader logo](https://raw.githubusercontent.com/FolioReader/FolioReaderKit/assets/folioreader.png)

[![Build Status](https://api.travis-ci.org/FolioReader/FolioReader-Android.svg?branch=master)](https://travis-ci.org/FolioReader/FolioReader-Android)

FolioReader-Android is an EPUB reader written in Java and Kotlin.

### Features

- [x] Custom Fonts

- [x] Custom Text Size

- [x] Themes / Day mode / Night mode

- [x] Text Highlighting

- [x] List / Edit / Delete Highlights

- [x] Handle Internal and External Links

- [x] Portrait / Landscape

- [ ] Reading Time Left / Pages left

- [x] In-App Dictionary

- [ ] Media Overlays (Sync text rendering with audio playback)

- [ ] TTS - Text to Speech Support

- [ ] Parse epub cover image

- [ ] PDF support

- [x] Book Search

- [x] Add Notes to a Highlight

- [ ] Better Documentation

- [x] Last Read Locator

- [x] Horizontal Reading

- [x] Distraction Free Reading

## Demo

##### Custom Fonts

![Custom fonts](https://cloud.githubusercontent.com/assets/1277242/19012915/0661c7b2-87e0-11e6-81d6-8c71051e1074.gif)

##### Day and Night Mode

![Day night mode](https://cloud.githubusercontent.com/assets/1277242/19012914/f42059c4-87df-11e6-97f8-29e61a79e8aa.gif)

##### Text Highlighting

![Highlight](https://cloud.githubusercontent.com/assets/1277242/19012904/c2700c3a-87df-11e6-97ed-507765b3ddf0.gif)

##### Media Overlays

![Media Overlay](https://cloud.githubusercontent.com/assets/1277242/19012908/d61f3ce2-87df-11e6-8652-d72b6a1ad9a3.gif)

### Gradle

Add following dependency to your root project `build.gradle` file:

```groovy

allprojects {

    repositories {

        ...

        jcenter()

        maven { url "https://jitpack.io" }

        ...

    }

}

```

Add following dependency to your app module `build.gradle` file:

```groovy

dependencies {

    ...

    implementation "com.folioreader:folioreader:0.5.4"

    ...

}

```

### Enable Multidex support

Enable Multidex support as explained in this [Android Doc](https://developer.android.com/studio/build/multidex)

### Usage

Get singleton object of `FolioReader`:

```java

FolioReader folioReader = FolioReader.get();

```

Call the function `openBook()`:

##### opening book from assets -

```java

folioReader.openBook("file:///android_asset/TheSilverChair.epub");

```

##### opening book from raw -

```java

folioReader.openBook(R.raw.accessible_epub_3);

```

## WIKI

* [Home](https://github.com/FolioReader/FolioReader-Android/wiki)

* [Configuration](https://github.com/FolioReader/FolioReader-Android/wiki/Configuration)

    * [Custom Configuration](https://github.com/FolioReader/FolioReader-Android/wiki/Custom-Configuration)

* [Highlight](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight)

    * [Highlight Action](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Action)

    * [Highlight Event](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Event)

    * [Providing External Highlight](https://github.com/FolioReader/FolioReader-Android/wiki/Providing-External-Highlight)

* [ReadLocator](https://github.com/FolioReader/FolioReader-Android/wiki/ReadLocator)

* [Clean up code](https://github.com/FolioReader/FolioReader-Android/wiki/Clean-up-code)

## Reporting Issue

See [KNOWN_ISSUES](https://github.com/FolioReader/FolioReader-Android/blob/master/KNOWN_ISSUES.md) and [CHANGELOG](https://github.com/FolioReader/FolioReader-Android/blob/master/CHANGELOG.md) first before reporting any issue. 


Please follow [Issue Template](https://github.com/FolioReader/FolioReader-Android/blob/master/.github/ISSUE_TEMPLATE.md) to report any issue.

## Share your application

If you are using FolioReader in your application, share your application link in [this issue](https://github.com/FolioReader/FolioReader-Android/issues/291)

### Credits

1. SwipeLayout

2. r2-streamer-kotlin

3. Pearson Dictionaries

4. rangy

### Author

[**Heberti Almeida**](https://github.com/hebertialmeida)

- Follow me on **Twitter**: [**@hebertialmeida**](https://twitter.com/hebertialmeida)

- Contact me on **LinkedIn**: [**hebertialmeida**](http://linkedin.com/in/hebertialmeida)

[**CodeToArt Technology**](https://github.com/codetoart)

- Follow us on **Twitter**: [**@codetoart**](https://twitter.com/codetoart)

- Contact us on **Website**: [**codetoart**](http://www.codetoart.com)

## 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**

 - [**Donate 5 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=5%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): Thank's for creating this project, here's a tea (or some juice) for you!

 - [**Donate 10 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=10%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): Wow, I am stunned. Let me take you to the movies!

 - [**Donate 15 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=15%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): I really appreciate your work, let's grab some lunch! 

 - [**Donate 25 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=25%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): That's some awesome stuff you did right there, dinner is on me!

 - [**Donate 50 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=50%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): I really really want to support this project, great job!

 - [**Donate 100 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&amount=100%2e00&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!

 - Of course, you can also [**choose what you want to donate**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hebertialmeida%40gmail%2ecom&lc=US&item_name=FolioReader%20Libraries&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted), all donations are awesome!

## License

FolioReaderKit is available under the BSD license. See the [LICENSE](https://github.com/FolioReader/FolioReader-Android/blob/master/License.md) file.