mirror of
https://github.com/jellyfin/jellyfin-plugin-bookshelf.git
synced 2024-11-23 05:39:51 +00:00
d38fa84f04
A epub file may contain multiple titles. As Jellyfin only supports one title, we want to make sure it is the main title. Additionally, the title_sort attribute is read in. |
||
---|---|---|
.github | ||
.vscode | ||
Jellyfin.Plugin.Bookshelf | ||
.editorconfig | ||
.gitignore | ||
build.yaml | ||
Directory.Build.props | ||
Jellyfin.Plugin.Bookshelf.sln | ||
jellyfin.ruleset | ||
LICENSE | ||
README.md |
Jellyfin Bookshelf Plugin
Part of the Jellyfin Project
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 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.
- 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
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.