jellyfin-plugin-opensubtitles/README.md

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

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

## About

This is a plugin allows you to download subtitles from [Open Subtitles](https://opensubtitles.com) for your media.

## Installation

[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).

## Build

1. To build this plugin you will need [.Net 8.x](https://dotnet.microsoft.com/download/dotnet/8.0).

2. Build plugin with following command
  ```
  dotnet publish --configuration Release --output bin
  ```

3. Place the dll-file in the `plugins/opensubtitles` 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.
Create initial README.md 2019-11-27 06:31:21 +00:00			`<h1 align="center">Jellyfin OpenSubtitles Plugin</h1>`
Update README.md Co-Authored-By: dkanada <dkanada@users.noreply.github.com> 2019-11-28 18:50:05 +00:00			`<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>`
Create initial README.md 2019-11-27 06:31:21 +00:00
			`<p align="center">`
update readme 2021-03-18 22:28:05 +00:00			`<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-opensubtitles.svg?sanitize=true"/>`
add basic readme badges 2021-03-12 18:08:22 +00:00			`<br/>`
			`<br/>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-opensubtitles/actions?query=workflow%3A%22Test+Build+Plugin%22">`
			`<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-opensubtitles/Test%20Build%20Plugin.svg">`
			`</a>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-opensubtitles">`
update readme 2021-03-18 22:28:05 +00:00			`<img alt="GPLv3 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-opensubtitles.svg"/>`
add basic readme badges 2021-03-12 18:08:22 +00:00			`</a>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-opensubtitles/releases">`
			`<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-opensubtitles.svg"/>`
			`</a>`
Create initial README.md 2019-11-27 06:31:21 +00:00			`</p>`

add basic readme badges 2021-03-12 18:08:22 +00:00			`## About`
update readme 2021-03-18 22:28:05 +00:00
Readme update & cleanup 2021-12-05 15:34:33 +00:00			`This is a plugin allows you to download subtitles from [Open Subtitles](https://opensubtitles.com) for your media.`
add basic readme badges 2021-03-12 18:08:22 +00:00
update readme 2021-03-18 22:28:05 +00:00			`## Installation`

			`[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).`

			`## Build`

10.9 support (#115) 2024-04-03 21:32:56 +00:00			`1. To build this plugin you will need [.Net 8.x](https://dotnet.microsoft.com/download/dotnet/8.0).`
update readme 2021-03-18 22:28:05 +00:00
			`2. Build plugin with following command`
			```
			`dotnet publish --configuration Release --output bin`
			```

			3. Place the dll-file in the `plugins/opensubtitles` 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.`
update readme 2020-02-23 15:57:27 +00:00
update readme 2021-03-18 22:28:05 +00:00			`## Contributing`
update readme 2020-02-23 15:57:27 +00:00
update readme 2021-03-18 22:28:05 +00:00			`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.`
update readme 2020-02-23 15:57:27 +00:00
update readme 2021-03-18 22:28:05 +00:00			`## Licence`
update readme 2020-02-23 15:57:27 +00:00
update readme 2021-03-18 22:28:05 +00:00			`This plugins code and packages are distributed under the GPLv3 License. See [LICENSE](./LICENSE) for more information.`