jellyfin-plugin-anidb/README.md

51 lines
2.3 KiB
Markdown
Raw Normal View History

2020-12-14 22:26:18 +00:00
<h1 align="center">Jellyfin AniDB Plugin</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
2013-10-26 21:18:02 +00:00
2019-01-30 14:21:11 +00:00
<p align="center">
2021-03-18 20:16:07 +00:00
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-anidb.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-anidb/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/blob/master/LICENSE">
<img alt="GPLv2 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-anidb.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-anidb.svg"/>
</a>
2019-01-30 14:21:11 +00:00
</p>
2013-10-27 18:58:37 +00:00
2021-03-18 20:16:07 +00:00
## About
2021-05-09 19:42:16 +00:00
2021-03-18 20:16:07 +00:00
This plugin adds the metadata provider for [aniDB](https://anidb.net/).
2020-02-23 15:33:58 +00:00
2021-05-09 19:42:16 +00:00
## Installation
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
2021-03-18 20:16:07 +00:00
## Build
2020-02-23 15:33:58 +00:00
2021-03-18 20:16:07 +00:00
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
2020-02-23 15:33:58 +00:00
2021-03-18 20:16:07 +00:00
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
2020-02-23 15:33:58 +00:00
2021-03-18 20:16:07 +00:00
3. Place the dll-file in the `plugins/anidb` 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 GPLv2 License. See [LICENSE](./LICENSE) for more information.