jellyfin/jellyfin-plugin-bookshelf
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-plugin-bookshelf.git synced 2024-11-23 05:39:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1,188 Commits 8 Branches 12 Tags 16 MiB
C# 99.1%
HTML 0.9%
fcb473f6f1
Go to file
renovate[bot] fcb473f6f1
chore(deps): update dependency sharpcompress to v0.32.0 (#61) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-06-13 18:49:57 +02:00
.github fix: meta ci workflows 2022-05-15 23:23:57 +02:00
Jellyfin.Plugin.Bookshelf chore(deps): update dependency sharpcompress to v0.32.0 (#61) 2022-06-13 18:49:57 +02:00
.editorconfig add standard editorconfig 2021-03-10 23:57:38 +01:00
.gitignore update csproj and remove build artifacts 2019-08-01 15:01:38 -07:00
build.yaml Update build.yaml 2022-03-27 18:00:38 -06:00
Directory.Build.props fix: meta ci workflows 2022-05-15 23:23:57 +02:00
Jellyfin.Plugin.Bookshelf.sln move all files to new location 2019-08-01 15:11:58 -07:00
jellyfin.ruleset Update ruleset and fix build 2021-11-18 18:28:57 -07:00
LICENSE minor changes to build metadata 2020-05-26 23:26:10 +09:00
README.md Update supported metadata providers and file types 2022-03-21 00:04:39 +00:00

README.md

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 his 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

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.