Awesome
<h1 align="center">Jellyfin Bookshelf Plugin</h1> <h3 align="center">Part of the <a href="https://jellyfin.org/">Jellyfin Project</a></h3> <p align="center"> <img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/> <br/> <br/> <a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/actions?query=workflow%3A%22Test+Build+Plugin%22"> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-bookshelf/Test%20Build%20Plugin.svg"> </a> <a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf"> <img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-bookshelf.svg"/> </a> <a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/releases"> <img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-bookshelf.svg"/> </a> </p>About
The Jellyfin Bookshelf plugin enables the collection of eBooks & AudioBooks, with the latter being able to be played through Jellyfin.
Supported eBook file types
- epub
- mobi
- cbz
- cbr
Supported audio book file types
Please take in mind that this is not a complete list and represents some of the most commonly used formats.
- mp3
- m4a
- m4b
- flac
Offline Metadata providers
This plugin supports the following offline Metadata providers. These will check the local files for metadata.
- Open Packaging Format (OPF)
- Calibre OPF
- ComicInfo
- ComicBookInfo
The following limitations apply:
- .cbr Comics tagged with ComicRacks ComicInfo format are partially supported. Any metadata within the comic book itself will be ignored while external metadata within a ComicInfo.xml file can be read.
- The Advanced Comic Book Format is not supported.
- The CoMet format is not supported.
Online Metadata providers
These Metadata providers will check online services for metadata.
- Google Books
- Comic Vine
To use the Comic Vine metadata provider, you will need to set an API key on the plugin's configuration page.
Build & Installation Process
-
Clone this repository
-
Ensure you have .NET Core SDK setup and installed
-
Build the plugin with following command:
dotnet publish --configuration Release --output bin
- Place the resulting
Jellyfin.Plugin.Bookshelf.dll
file in a folder calledplugins/
inside your Jellyfin installation / data directory.