Skip to content

A nice way to read books and comics from Jellyfin

License

Notifications You must be signed in to change notification settings

weblate/JellyBook

 
 

Repository files navigation

JellyBook

A book a comic reading app for Jellyfin

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

⚡ Ways to Downloading:

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 depricated functions
  • The view for them currently only supports horizontal scroll
  • 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 nto show a progress indicator
.pdf
  • Sometimes gives a error that it 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'd I 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
  • Have a more universal experience between the rest of the formats and pdfs (pdf work a bit differently)
  • Allow local caching of current files and still able to browse what books in 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 Overhall 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 a Android app made in Flutter which 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 apps data after upgrading so that it still functions as intended
  • Weslate features are not currently implimented

📞 Contact Me

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

⚙️ Contributing:

  • Check out our wiki: Here

📚 Translating:

  • placeholder text

🎉 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

Packages

No packages published

Languages

  • Dart 97.7%
  • Ruby 1.5%
  • Java 0.3%
  • Shell 0.2%
  • Swift 0.2%
  • C 0.1%