Jellyfin.Plugin.FileTransformation 1.2.1-alpha.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Jellyfin.Plugin.FileTransformation.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Jellyfin.Plugin.FileTransformation --version 1.2.1-alpha.2                

                    
                

            
NuGet\Install-Package Jellyfin.Plugin.FileTransformation -Version 1.2.1-alpha.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Jellyfin.Plugin.FileTransformation" Version="1.2.1-alpha.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Jellyfin.Plugin.FileTransformation --version 1.2.1-alpha.2                

                    
                

            
#r "nuget: Jellyfin.Plugin.FileTransformation, 1.2.1-alpha.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Jellyfin.Plugin.FileTransformation as a Cake Addin
#addin nuget:?package=Jellyfin.Plugin.FileTransformation&version=1.2.1-alpha.2&prerelease

// Install Jellyfin.Plugin.FileTransformation as a Cake Tool
#tool nuget:?package=Jellyfin.Plugin.FileTransformation&version=1.2.1-alpha.2&prerelease

<h1 align="center">File Transformation</h1> <h2 align="center">A Jellyfin Plugin</h2> <p align="center"> <img alt="Logo" width="256" height="256" src="https://camo.githubusercontent.com/ab4b1ec289bed0a0ac8dd2828c41b695dbfeaad8c82596339f09ce23b30d3eb3/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f73656c666873742f69636f6e732f776562702f6a656c6c7966696e2e77656270" /> <br /> <sub>Custom Logo Coming Soon</sub> <br /> <br /> <a href="https://github.com/IAmParadox27/jellyfin-plugin-home-sections"> <img alt="GPL 3.0 License" src="https://img.shields.io/github/license/IAmParadox27/jellyfin-plugin-file-transformation.svg" /> </a> <a href="https://github.com/IAmParadox27/jellyfin-plugin-home-sections/releases"> <img alt="Current Release" src="https://img.shields.io/github/release/IAmParadox27/jellyfin-plugin-file-transformation.svg" /> </a> <a href="https://www.nuget.org/packages/Jellyfin.Plugin.FileTransformation"> <img alt="NuGet Release" src="https://img.shields.io/nuget/v/Jellyfin.Plugin.FileTransformation" /> </a> <a href="https://www.nuget.org/packages/Jellyfin.Plugin.Referenceable/1.2.1"> <img alt="Shield Example" src="https://img.shields.io/badge/JF%20Referenceable-v1.2.1-blue" /> </a> </p>

Introduction

File Transformation is a Referenceable Jellyfin Plugin (and C# Library) that can be used to modify the served jellyfin-web content without having to modify the files directly.

⚠️ This plugin makes use of Jellyfin Referenceable using version 1.2.1. Ensure all plugins that use this plugin are compatible with that version.

The use cases for this can be seen in my other plugins plugin-pages and home-sections which both take advantage of this.

Credit

The original code and concept for this plugin came from this Pull Request from JPVenson. A lot of the code is unmodified (bar personal code standards).

Benefits

Why would I use this rather than just asking installers to change the files?

Well, this plugin is non destructive and allows multiple plugins to manipulate the served data. The install remains clean and free for users to update their Jellyfin server whenever they want.

Installation

  1. Add https://www.iamparadox.dev/jellyfin/manifest.json as a plugin source repository on your Jellyfin server.
  2. Find "File Transformation" in the list and install it. No configuration is required.

Prerequisites

Plugin Version Jellyfin Version
1.1.0 10.10.3
1.2.* 10.10.5

Referencing this as a library

Add Jellyfin.Plugin.FileTransformation from NuGet using the most appropriate version from the table above. All versions previous to 1.1.0 do not work correctly and have issues which were only discovered after making the release.

<PackageReference Include="Jellyfin.Plugin.FileTransformation" Version="1.2.1" />

Requests

If any functionality is desired to be overridden from Jellyfin's server please open a feature-request issue on GitHub.

FAQ

Frequent questions will be added here as they are asked.

Ensure that you check the closed issues on GitHub before asking any questions as they may have already been answered.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Jellyfin.Plugin.FileTransformation:

Package Downloads
Jellyfin.Plugin.HomeScreenSections

Package Description
Jellyfin.Plugin.PluginPages

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.1 104 2/2/2025
1.2.1-alpha.2 33 2/2/2025
1.2.1-alpha.1 35 2/2/2025
1.2.0 90 2/2/2025
1.2.0-alpha.1 36 2/2/2025
1.1.1-alpha.2 38 2/2/2025
1.1.1-alpha.1 27 1/30/2025
1.1.0 69 1/30/2025
1.1.0-alpha.2 9 1/30/2025
1.0.2 63 1/29/2025
1.0.2-alpha.1 33 1/28/2025
1.0.1 80 1/28/2025
1.0.0 77 1/28/2025
0.0.1-alpha.1 31 1/28/2025