jellyfin-plugin-nextpvr/README.md

51 lines
2.3 KiB
Markdown
Raw Normal View History

2020-02-19 02:03:28 +00:00
<h1 align="center">Jellyfin NextPVR Plugin</h1>
2020-03-25 16:50:37 +00:00
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
2019-09-30 21:54:30 +00:00
2021-03-10 23:40:29 +00:00
<p align="center">
2021-03-18 22:18:37 +00:00
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-nextpvr.svg?sanitize=true"/>
2021-03-10 23:40:29 +00:00
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-nextpvr/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-nextpvr/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-nextpvr">
<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-nextpvr.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-nextpvr/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-nextpvr.svg"/>
</a>
</p>
2020-02-19 02:03:28 +00:00
## About
2019-09-30 21:54:30 +00:00
2021-03-18 22:18:37 +00:00
This plugin provides access to live TV, program guide, and recordings from a [NextPVR](http://www.nextpvr.com) server.
2020-02-19 02:03:28 +00:00
2021-03-18 22:18:37 +00:00
## Installation
2020-02-19 02:03:28 +00:00
2021-03-18 22:18:37 +00:00
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
2020-05-27 11:28:25 +00:00
2021-03-18 22:18:37 +00:00
## Build
2020-05-27 11:28:25 +00:00
2021-03-18 22:18:37 +00:00
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
2020-02-19 02:03:28 +00:00
2021-03-18 22:18:37 +00:00
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
2020-02-19 02:03:28 +00:00
2021-03-18 22:18:37 +00:00
3. Place the dll-file in the `plugins/nextpvr` 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 MIT License. See [LICENSE](./LICENSE) for more information.