https://github.com/jellyfin/jellyfin-plugin-bookshelf
https://github.com/jellyfin/jellyfin-plugin-bookshelf
hacktoberfest
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jellyfin/jellyfin-plugin-bookshelf
- Owner: jellyfin
- License: mit
- Created: 2019-01-04T07:52:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-13T20:37:28.000Z (6 months ago)
- Last Synced: 2025-05-16T09:06:17.415Z (6 months ago)
- Topics: hacktoberfest
- Language: C#
- Homepage: https://jellyfin.org
- Size: 15.5 MB
- Stars: 274
- Watchers: 10
- Forks: 24
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Self-Hosting-Guide - Jellyfin Bookshelf Plugin
README
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
- 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.
- [Open Packaging Format (OPF)](http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm)
- Calibre OPF
- [ComicInfo](https://github.com/anansi-project/comicinfo)
- [ComicBookInfo](https://code.google.com/archive/p/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](https://launchpad.net/acbf)_ is not supported.
- The _[CoMet](https://www.denvog.com/comet/comet-specification/)_ 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:
```bash
dotnet publish --configuration Release --output bin
```
4. Place the resulting `Jellyfin.Plugin.Bookshelf.dll` file in a folder called `plugins/` inside your Jellyfin installation / data directory.