Skip to content

jellyfin/jellyfin-plugin-bookshelf

Repository files navigation

Jellyfin Bookshelf Plugin

Part of the Jellyfin Project

Logo Banner

GitHub Workflow Status MIT License Current Release

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
  • pdf
  • 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.

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

  1. Clone this repository

  2. Ensure you have .NET Core SDK setup and installed

  3. Build the plugin with following command:

dotnet publish --configuration Release --output bin
  1. Place the resulting Jellyfin.Plugin.Bookshelf.dll file in a folder called plugins/ inside your Jellyfin installation / data directory.