jellyfin-plugin-imvdb/README.md

51 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2022-01-25 01:40:32 +00:00
<h1 align="center">Jellyfin IMVDb Plugin</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
2020-10-26 14:18:20 +00:00
2022-01-25 01:40:32 +00:00
<p align="center">
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-imvdb.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-imvdb/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-imvdb/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-imvdb">
<img alt="GPLv3 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-imvdb.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-imvdb/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-imvdb.svg"/>
</a>
</p>
2021-04-04 17:49:00 +00:00
2022-01-25 01:40:32 +00:00
## About
2020-10-26 14:18:20 +00:00
2022-01-25 01:40:32 +00:00
This plugin adds the metadata provider for [IMVDb](https://imvdb.com//).
2020-10-26 14:18:20 +00:00
2022-01-25 01:40:32 +00:00
## Installation
2020-10-26 14:18:20 +00:00
2022-01-25 01:40:32 +00:00
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
2020-10-26 14:18:20 +00:00
2022-01-25 01:40:32 +00:00
## Build
1. To build this plugin you will need [.NET 6.x](https://dotnet.microsoft.com/download/dotnet/).
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
3. Place the dll-file in the `plugins/imvdb` folder (you might need to create the folders) of your JF install
## Releasing
To release the plugin we recommend [JPRM](https://github.com/oddstr13/jellyfin-plugin-repository-manager) that will build and package the plugin.
For additional context and for how to add the packaged plugin zip to a plugin manifest see the [JPRM documentation](https://github.com/oddstr13/jellyfin-plugin-repository-manager) for more info.
## Contributing
We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.
In general refer to our [contributing guidelines](https://github.com/jellyfin/.github/blob/master/CONTRIBUTING.md) for further information.
## Licence
This plugins code and packages are distributed under the GPLv3 License. See [LICENSE](./LICENSE) for more information.