Code Monkey home page Code Monkey logo

jellybook's Introduction

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 ebooks, comics, and listen to audiobooks from your Jellyfin server.

Table of Contents

โšก Installation:

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

Soon to be submitted to the F-Droid store

Other Platforms If you would like to see this app on your platform, please open an issue and I will see what I can do.

๐Ÿ“ท Screenshots (and videos):

Click to expand

 JellyBook demo video

Screen Images (Phone) Images (Tablet)
Library Screen
Collection Screen
Book Info Screen
Search Screen

๐Ÿ“ 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 does not show a progress indicator.
.cbz & .zip
  • 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.

๐ŸŽต Audiobook formats:

  • Currently, the app supports the following formats:
    • flac
    • mpga
    • mp3
    • m3u
    • m3u8
    • m4a
    • m4b
    • wav

Note: this is partially due to the fact that Jellyfin Bookshelf Plugin only currently supports epub, mobi, pdf, cbz, and cbr for books and mp3, m4a, m4b, and flac for audiobooks. I am unsure if other formats can be added here until the plugin is updated.

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

  • .aax
  • .aac
  • .ogg

๐Ÿšง Todo:

  • A more consistent experience between all book formats
  • Redesign several screens to give them a more cross-platform and polished feel
  • Multiple server support
  • 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
    • I also want to make it more visually appealing (I am a programmer, not a designer and would love some help with this)
  • Background download
  • Publish to several stores
  • Proper code documentation
  • Proper testing (unit, integration, and widget... I have very little experience with this)
  • Full code restructuring and refactoring
  • Use Tentacle as new API client (must work on this first)
  • Add a proper page on IzzyOnDroid using fastlane (see here)
  • Add dynamic loading of books on library view to prevent slowdowns
  • Allow user to edit metadata of books (both locally and on the server)
  • Vertical scrolling
  • Audiobooks
  • Allow local caching of current files while viewing collection when offline (proper offline support)
  • Remember user support
  • Settings page

๐Ÿ“ž Contact Me

โš™๏ธ 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
  • Thank you to IzzyOnDroid for packaging and hosting the app on their repo

๐Ÿค” Why is Development so Slow?

  • I am a full time student and work part time. I recently had midterms come up which caused me to have to slow down on my working on this project. This project is really fun to work on for me but that being said, without making any money from it or receiving any donations my ability to work on this project is hindered. This is since I do need money to help pay for my education and living expenses. I would really love to be able to work on open source full time but unfortunately that is not possible at this current time to work on it like how I was previously.
  • That all being said, I do also have a tendency to burn out a lot when going at the rate I was going when I started this project so have tried to slow down to a pace where I'm ensuring I don't burn out and slowly over time plan to increase my frequency of working on this project to a place more close to where it was previously.

jellybook's People

Contributors

21repierre avatar alison2033 avatar bittin avatar comradekingu avatar creeperwithrabies avatar dependabot[bot] avatar fjuro avatar izzysoft avatar kacperhaha avatar kara-zor-el avatar kofzhanganguo avatar kuragehimekurara1 avatar liimee avatar milotype avatar mystery14 avatar networkuka avatar nickskier avatar nouchka avatar pigratestudo avatar pm09sx avatar rafo avatar santossi avatar starring94 avatar stseifer avatar tarbaii avatar tnzzzhlp avatar ultimatemedia avatar weblate avatar witherofmc avatar z369369 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.