jellyfin-plugin-bookshelf/README.md

<h1 align="center">Jellyfin Bookshelf Plugin</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org/">Jellyfin Project</a></h3>

<p align="center">

<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-bookshelf/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf">
<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-bookshelf.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-bookshelf.svg"/>
</a>
</p>

## 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.
update readme 2020-02-18 08:07:05 +00:00			`<h1 align="center">Jellyfin Bookshelf Plugin</h1>`
			`<h3 align="center">Part of the <a href="https://jellyfin.org/">Jellyfin Project</a></h3>`
Update README.md 2013-02-22 16:33:07 +00:00
add basic readme badges 2021-03-10 23:02:15 +00:00			`<p align="center">`

			`<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>`
			`<br/>`
			`<br/>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/actions?query=workflow%3A%22Test+Build+Plugin%22">`
			`<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-bookshelf/Test%20Build%20Plugin.svg">`
			`</a>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf">`
			`<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-bookshelf.svg"/>`
			`</a>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-bookshelf/releases">`
			`<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-bookshelf.svg"/>`
			`</a>`
			`</p>`

update readme 2020-02-18 08:07:05 +00:00			`## About`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00			`The Jellyfin Bookshelf plugin enables the collection of eBooks & AudioBooks, with the latter being able to be played through Jellyfin.`
Update README.md 2013-02-22 16:33:07 +00:00
Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			`### Supported eBook file types`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
update readme 2020-02-18 08:07:05 +00:00			`- epub`
			`- mobi`
			`- pdf`
			`- cbz`
			`- cbr`
Update README.md 2013-02-22 16:33:07 +00:00
Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			`### Supported audio book file types`
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00
Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			`Please take in mind that this is not a complete list and represents some of the most commonly used formats.`
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00
			`- mp3`
			`- m4a`
			`- m4b`
			`- flac`

Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			`### Offline Metadata providers`
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00
			`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/)`

Clarify which comic metadata formats are supported 2021-10-02 18:24:26 +00:00			`The following limitations apply:`
Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00
Clarify which comic metadata formats are supported 2021-10-02 18:24:26 +00:00			`- .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.`
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00			`- The _[CoMet](https://www.denvog.com/comet/comet-specification/)_ format is not supported.`

Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			`### Online Metadata providers`
Update supported metadata providers and file types All metadata providers this plugin provides are being listed in the appropriate places. The list of supported file types is being supplemented by the addition of some audio book file types. Due to the immense list of audio file types that are supported by Jellyfin, only a few selected are being mentioned. Those should include the most commonly used file types for audio books. 2022-03-21 00:04:39 +00:00
			`These Metadata providers will check online services for metadata.`

			`- Google Books`
Add Comic Vine metadata provider (#81) * Move file name parsing logic to a separate class * Add the Comic Vine API key to the configuration page * Add models for the Comic Vine API * Update the Comic Vine providers * Add test fixtures and some empty tests for the Comic Vine provider. * Update issue search and complete GetSearchResults tests * Complete GetMetadata tests for the Comic Vine provider * Add test for the Comic Vine image provider * Add Comic Vine information to the readme * Fix typo in Comic Vine provider * Fix some CodeQL warnings * Fix some more CodeQL issues and add more tests * Change displayed image in Comic Vine search results * Update regex number match * Update fixture files inclusion 2023-11-02 13:47:38 +00:00			`- Comic Vine`

			`To use the Comic Vine metadata provider, you will need to set an API key on the plugin's configuration page.`
Clarify which comic metadata formats are supported 2021-10-02 18:24:26 +00:00
update readme 2020-02-18 08:07:05 +00:00			`## Build & Installation Process`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
update readme 2020-02-18 08:07:05 +00:00			`1. Clone this repository`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
update readme 2020-02-18 08:07:05 +00:00			`2. Ensure you have .NET Core SDK setup and installed`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
update readme 2020-02-18 08:07:05 +00:00			`3. Build the plugin with following command:`
minor changes to build metadata 2020-05-26 14:26:10 +00:00
Fix typo and improve README formatting (#74) 2023-05-30 00:59:05 +00:00			```bash
update readme 2020-02-18 08:07:05 +00:00			`dotnet publish --configuration Release --output bin`
			```
updated readme 2013-03-03 17:07:00 +00:00
minor changes to build metadata 2020-05-26 14:26:10 +00:00			4. Place the resulting `Jellyfin.Plugin.Bookshelf.dll` file in a folder called `plugins/` inside your Jellyfin installation / data directory.