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,243 Commits 8 Branches 12 Tags 16 MiB
C# 99.1%
HTML 0.9%
58c1d56a91
Go to file
renovate[bot] 58c1d56a91
Update xunit-dotnet monorepo (#84) 
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-10-26 11:56:14 -06:00
.github add unstable workflow 2024-03-25 19:53:20 -06:00
.vscode Add development setup for Visual Studio Code (#64) 2022-08-07 14:35:19 +02:00
Jellyfin.Plugin.Bookshelf Update dependency Microsoft.Extensions.Http to 8.0.1 (#115) 2024-10-26 11:56:08 -06:00
tests/Jellyfin.Plugin.Bookshelf.Tests Update xunit-dotnet monorepo (#84) 2024-10-26 11:56:14 -06: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 Add support for covers from .cbt, .cb7 and .cbr (#112) 2024-09-12 13:44:36 -06:00
Directory.Build.props Prepare for release v11 (#99) 2024-05-11 13:17:38 -06:00
Jellyfin.Plugin.Bookshelf.sln Add Google Books external id (#80) 2023-10-26 13:45:57 -06:00
jellyfin.ruleset 10.9 2024-05-11 13:16:07 -06:00
LICENSE minor changes to build metadata 2020-05-26 23:26:10 +09:00
README.md Add Comic Vine metadata provider (#81) 2023-11-02 07:47:38 -06: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 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.