Skip to content

A nice way to read books and comics from Jellyfin

License

Notifications You must be signed in to change notification settings

Mystery14/JellyBook

 
 

Repository files navigation

JellyBook

A book and comic reader for Jellyfin

Hi, this is a passion project I am working on. Its an app that's meant to allow you to read your files from Jellyfin on mobile. It is in a state where I do beleive it's usable for most comic reading and some books, but it still has a long way to go.

⚡ Installation:

Platform Link
iOS Download on TestFlight
Android Download the latest release for your current platform from the releases. It will at some point be added to the Google Play store and the F-Droid store.

📁 File formats:

Format Known Issues / Planned Features Specification(s)
.cbr & .rar
  • CBR is a proprietary file format so is not necessarily encouraged.
  • CBR files don't support streaming yet.
  • The library is using deprecated functions.
  • The view for them currently only supports horizontal scrolling.
  • The view for them currently does not show a progress indicator.
.cbz & .zip
  • CBZ files don't support streaming yet.
  • The view for them currently only supports horizontal scrolling.
  • The view for them currently does not show a progress indicator.
.pdf
  • Sometimes throws an error that the content isn't downloaded even when it is.
  • Only supports horizontal scrolling currently.
  • No progress bar currently.
.epub
  • Image support is not the greatest.
  • No horizontal support yet.
  • Just not in a state where I'd consider the support proper.

Currently Unsupported Filetypes

  • .cbt/.tar
  • .cba/.ACE
  • .cb7/.7z
  • tar.gz
  • .WebP
  • .gif
  • .lrf/.lrx
  • .djvu
  • .pdb
  • .fb2
  • .ibooks
  • .azw/.azw3/.kf8/.kfx
  • .pcf/.mobi
  • .opf
  • .txt
  • .oxps/.xps

Currently Unsupported Audiobooks Filetypes

  • .mp3
  • .aax
  • .m4a/.m4b
  • .aac
  • .ogg
  • .flac
  • .wav

🚧 Todo:

  • Vertical scrolling
  • Audiobooks
  • A more consistent experience between the rest of the formats and PDFs (PDFs work a bit differently)
  • Allow local caching of current files while viewing collection when offline (proper offline support)
  • Remember user support
  • Multiple server support
  • Settings page
  • For the download completed screen I want to add a image or GIF of a jellyfish reading a book (credit to thornbill on the Matrix server for that idea)
  • UI overhaul in several areas of the app (will keep current as options for those who want it) - [ ] Part of the current issue is that it looks like an Android app made in Flutter; although it is made in Flutter, I want it to have a more cross-platform feel to it
  • Background download
  • Publish to several stores

⚠️ Known Issues

  • Due to the re-working of several components, you may need to reset the app's data after upgrading so that it still functions as intended

📞 Contact Me

  • Discord: kmp3e#9430
  • Matrix: @kmp3e:matrix.org
  • Feel free to submit an issue on GitHub

⚙️ Contributing:

📚 Translating:

Translation status

🎉 Special Thanks:

  • Thank you to u/anekdotos on Reddit for donating to the project so it could be published on iOS
  • Thank you to Weblate for hosting translation

About

A nice way to read books and comics from Jellyfin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 97.8%
  • Ruby 1.2%
  • Shell 0.6%
  • Java 0.2%
  • Swift 0.1%
  • C 0.1%