Hey all! Things are changing with my plugins are more and more people start to use them and report issues. In order to make it easier for me to manage I'm splitting bugs and features into different areas. For feature requests please head over to https://features.iamparadox.dev/ where you'll be able to signin with GitHub and make a feature request. For bugs please report them on the relevant GitHub repo and they will be added to the project board when I've seen them. I've found myself struggling to know when issues are made and such recently so I'm also planning to create a system that will monitor a particular view for new issues that come up and send me a notification which should hopefully allow me to keep more up to date and act faster on various issues.
As with a lot of devs, I am very momentum based in my personal life coding and there are often times when these projects may appear dormant, I assure you now that I don't plan to let these projects go stale for a long time, there just might be times where there isn't an update or response for a couple weeks, but I'll try to keep that better than it has been. With all new releases to Jellyfin I will be updating as soon as possible, I have already made a start on 10.11.0 and will release an update to my plugins hopefully not long after that version is officially released!
File Transformation is a Jellyfin Plugin that can be used to modify the served jellyfin-web content without having to modify the files directly.
The use cases for this can be seen in my other plugins plugin-pages and home-sections which both take advantage of this.
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).
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.
- Add
https://www.iamparadox.dev/jellyfin/plugins/manifest.jsonas a plugin source repository on your Jellyfin server. - Find "File Transformation" in the list and install it. No configuration is required.
| Plugin Version | Jellyfin Version |
|---|---|
| 2.0.0 | 10.10.5 |
Due to issues with Jellyfin's plugins being loaded into different load contexts this cannot be referenced directly.
Instead you can use reflection to invoke the plugin directly to register your transformation.
- Prepare your payload
{
"id": "00000000-0000-0000-0000-000000000000", // Guid
"fileNamePattern": "", // Regex Patterm for the file to patch
"callbackAssembly": GetType().Assembly.FullName, // Example value is a string from C# that should be resolved before adding to json
"callbackClass": "", // The name of the class that should be invoked from the above assembly
"callbackMethod": "" // The name of the function that should be invoked from the above class
}- Send your payload to the file transformation assembly
Assembly? fileTransformationAssembly =
AssemblyLoadContext.All.SelectMany(x => x.Assemblies).FirstOrDefault(x =>
x.FullName?.Contains(".FileTransformation") ?? false);
if (fileTransformationAssembly != null)
{
Type? pluginInterfaceType = fileTransformationAssembly.GetType("Jellyfin.Plugin.FileTransformation.PluginInterface");
if (pluginInterfaceType != null)
{
pluginInterfaceType.GetMethod("RegisterTransformation")?.Invoke(null, new object?[] { payload });
}
}When your transformation method is invoked you will receive a object representing the following json format
{
"contents": "" // String containing the current state of the file being requested.
}If any functionality is desired to be overridden from Jellyfin's server please open a request on https://features.iamparadox.dev.
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.
