Jellyfin TubeArchivist Plugin

Plugin Banner

> [!IMPORTANT] > Jellyfin release cycle has changed in the past few months and now it is shorter than before. The plugin supports only the latest Jellyfin release, in order to continue using this plugin with all the latest features you will need to upgrade your Jellyfin installation. > The same rule applies to TubeArchivist: the plugin is only guaranteed to work with the latest TubeArchivist version. > [!WARNING] > Jellyfin 10.10 introduced a bug that prevents the plugin to correctly create Season folders by year. The bug has been finally solved on the Jellyfin codebase, but, until the next minor release, a manual build of the Jellyfin branch `release-10.10.z` is required in order to get the fix running.
> This is not a plugin bug, any issue opened about this bug will be immediately closed! ## About

This plugin adds the metadata provider for TubeArchivist, offering improved flexibility and native integration with Jellyfin compared to previous solutions.

## How it works The media organization is a `Shows` collection, where each channel is a show and its videos are the episodes, organized in seasons by year.
The plugin interacts with TubeArchivist APIs to fetch videos and channels metadata. ### Features - Add metadata for videos (episodes) - Add metadata for channels (shows) - Add images for videos (episodes), ie. thumb images - Add images for channels (shows), ie. thumb, tvart and banner images - Organize videos (episodes) by year (seasons) - Bidirectional playback progress synchronization - Bidirectional playlists synchronization > [!WARNING] > Enabling synchronization in both directions you can run in race conditions and unexpected results. ## Installation ### From official repository (recommended) 1. Go to `Dashboard -> Plugins` and click on the `Manage Repositories` button 2. Add a new repository with the following details: - Repository name: `TubeArchivistMetadata` - Repository URL: `https://github.com/tubearchivist/tubearchivist-jf-plugin/raw/master/manifest.json` ![Add repository](https://github.com/user-attachments/assets/337ba921-bc97-47ea-815c-c664cf7661a2) 3. Go back to the catalog 4. Find `TubeArchivistMetadata` and install it ![Find plugin](https://github.com/user-attachments/assets/41f7315b-27c6-47dd-958f-21a232c30013) 5. Restart Jellyfin to apply the changes ### From ZIP in GitHub releases 1. Download the latest available release (`tubearchivistmetadata_*.zip`) from the repository releases section 2. Extract the contained files in the `plugins/TubeArchivistMetadata` folder (you might need to create the folders) of your Jellyfin installation 3. Restart Jellyfin to apply the changes ## Configuration

This plugin requires that you have already an instance of TubeArchivist up and running.

Once installed, you have to configure the following parameters in the plugin configuration: ![Plugin configuration](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/d34464ea-ddfb-44b3-9d3e-5d5974956c58) ## Use the plugin

Using the plugin is very simple. Let's start from the beginning:

_NOTE: If you are using Docker containers, it is important to mount the TubeArchivist media path into Jellyfin container as **read-only**, in order to avoid possible operations on the media files that will break TubeArchivist._
1. Go to `Dashboard -> Libraries` and add a media library 2. In the form select `Shows` as Content type, set a display name for the library and set the TubeArchivist media folder in the `Folders` section ![Add library](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/1eca534e-0929-4134-8587-3cff0009f618) 4. Scrolling down, uncheck all metadata and image providers except `TubeArchivist`. (You won't find TubeArchivist in seasons providers, so just disable everything there) 5. Save and come back to Home, you will see the newly added library. Jellyfin will have executed the metadata fetching for you after the collection creation and then you will see the metadata and the images of channels and videos ## Synchronization This plugin has different bidirectional sycnhronization features, that can be configured in the specific section in the plugin configuration page: ![Synchronization settings](https://github.com/user-attachments/assets/b0bb556b-fce3-4a3e-bc6c-b0a2b482cedc) ### Playback synchronization

Starting from v1.3.1 this plugin offers playback progress and watched status bidirectional synchronization, but you can choose to enable only a one way synchronization (Jellyfin -> TubeArchivist or TubeArchivist -> Jellyfin) too.

#### Jellyfin -> TubeArchivist playback synchronization

This kind of synchronization is done listening for progress and watched status changes while playing the videos for the specified users.
Furthermore, there is a task that runs at Jellyfin startup to synchronize the whole library.

In the text field you can specify one Jellyfin username to synchronize data of to TubeArchivist.

#### TubeArchivist -> Jellyfin playback synchronization

This kind of synchronization is done using a Jellyfin scheduled task that regularly synchronizes data from TubeArchivist API to Jellyfin.

In the text field you can specify one or more Jellyfin usernames to update data for.

### Playlists synchronization

Starting from v.1.4.1 this plugin offers playlists bidirectional synchronization, but you can choose to enable only a one way synchronization (Jellyfin -> TubeArchivist or TubeArchivist -> Jellyfin) too.

#### Jellyfin -> TubeArchivist playlists synchronization

There is a task that retrieves playlists and recreates them on TubeArchivist with the videos in the same order. Please note that playlists can also have videos not beloging from TubeArchivist, they will be simply ignored, so you won't find them on TubeArchivist playlist.

It is present also a setting to automatically delete playlists from TubeArchivist when they are no more available on Jellyfin.

#### TubeArchivist -> Jellyfin playlists synchronization

There is a task that retrieves playlists from TubeArchivist and recreates them on Jellyfin with videos in the same order.

It is present, also in this case, a setting to automatically delete playlists from Jellyfin when they are no more present on TubeArchivist, but beware that the will be deleted also if they contain videos not beloning to TubeArchivist.

> [!CAUTION] > Pay attention when you enable the automatic deletion options, be sure that is your wanted behavior, especially when playlists contain also other videos not belonging from TubeArchivist, playlists removed won't be available again, there's no undo! ## Tasks intervals

Since many of the feature are implemented as background tasks periodically executing, in the `Tasks intervals` section you will find the settings to adjust this period in seconds.
Keep in mind that Jellyfin lowest accepted period is of 1 minute (60 seconds) and the lower is the interval the higher will be the resources consuption on your system.

Here are the configurable intervals:

![Tasks intervals settings](https://github.com/user-attachments/assets/19db6b83-6715-477d-8ce7-b78526e87ba9) ## Build 1. To build this plugin you will need [.Net 9.x](https://dotnet.microsoft.com/download/dotnet/9.0). 2. Build plugin with following command ``` $ dotnet publish Jellyfin.Plugin.TubeArchivistMetadata --configuration Release --output bin ``` 3. Place the dll-file in the `plugins/tubearchivist-jf-plugin` folder (you might need to create the folders) of your Jellyfin installation ## License This plugins code and packages are distributed under the GPLv3 License. See [LICENSE](./LICENSE) for more information.