Skip to content

Book's Story β€” Material You eBook reader built with Jetpack Compose. Free & Open source & Ad-free, with extensive customization options and support for multiple file formats.

License

Notifications You must be signed in to change notification settings

Acclorite/book-story

Repository files navigation

Book's Story

Material3 Book Reader for Android

Dive into the world of adventure as you discover your favorite book's story!

Latest Stable Release F-Droid Release IzzyOnDroid Release Downloads Matrix Stars Translation Status Development Stage Last Commit License: GPL-3.0 Repository Size

Overview

Built using Jetpack Compose and Kotlin.

πŸ–ŒοΈ Screenshots


You can find more screenshots in assets folder.

✈️ Download

  • Please note, that the app supports Android versions only from Android 8.0

Get it on GitHub Get it on F-Droid Get it on IzzyOnDroid

Don't see your favorite app store? Create an Issue! (Except Play Store, this app won't be there)

πŸ“² How to download and install

  • Install from Github: Click on the "Get it on GitHub" badge above, scroll down and download book-story.apk or download the last apk from GitHub here. After that, find downloaded APK and install it.
  • Install from F-Droid: Click on the "Get it on F-Droid" badge above, scroll down and click "Download APK" under desired Release Version to download the APK file. After that, find downloaded APK and install it.
  • Install from IzzyOnDroid: Click on the "Get it on IzzyOnDroid" badge above, scroll down and click "Download" to download the last APK from IzzyOnDroid. After that, find downloaded APK and install it.
  • If you don't know how to install APK file, follow this guide.

🧭 Afterwards

  • Open the app and follow basic instructions.
  • If you don't understand how to use the app, please read everything in the app's Help Screen. (You can find it in: Library, History, Browse β†’ Three Dots β†’ Help)
  • If you still have questions, please feel free to ask in Discussions, or create an Issue if you feel like some area should be documented better.

✨ Features

  • 8 supported file formats(.pdf, .txt, .epub, .fb2, .zip, .html, .htm, .md)
  • Chapters in Reader
  • Color Presets for Reader
  • Categories to organize your Library
  • Check for app updates on app startup
  • Anti error protection(you cannot add/update a book if it is not valid)
  • Highly customizable Reader
  • Double click translation(sends to the external translator)
  • Translate and Dictionary options when text is selected in Reader
  • Material3 latest design guidelines
  • 10 unique themes
  • MaterialYou Dynamic Theme support
  • Simple UI
  • Tablet UI support
  • Help screen
  • More..

πŸ˜΅β€πŸ’« Upcoming features / Roadmap

  • You can track project's progress, see what's coming and what is already implemented in Book's Story: Development Roadmap.
  • Some features may not be in Roadmap due to small size or other factors.

🌐 Translation

Translation progress

You can help translating the app on Hosted Weblate.

🀝 How to contribute

  • The most improtant thing is I do not want someone's code. This project is maintaining only by me and I want it to be this way. Creating Pull Requests will not have much sense as they will probably be closed.
  • Place your suggestions on Issues with Suggestion Needed label. When the issue has this label that means I seek new ideas on how to improve what I already propose. Feel free to tell me what's on your mind!
  • Join Matrix server. You can share your ideas, make bug reports and just chat with me on my Matrix server!
  • Share your ideas and suggestions. Your ideas and suggestions are always welcome, if you miss some feature or got an interesting idea, feel free to create a new Issue.
  • Report bugs. Had a crash or something went wrong? Create a new Issue, the more information you can give the better it is.
  • Translate the app. You can do what I physically cannot - translate the app on multiple languages. For this you can use Hosted Weblate.
  • Enjoy the app. Your best contribution is using my app and enjoying it!

πŸ€— Credits

🧾 License

    GNU GENERAL PUBLIC LICENSE
    Version 3, 29 June 2007 
Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.