tubearchivist / tubearchivist-jf-plugin

Metadata for your TubeArchivist library on Jellyfin.

Jellyfin TubeArchivist Plugin

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)

Installation

From official repository (recommended)

1. Go to Dashboard -> Plugins and select the Repositories tab
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

3. Go to the Catalog tab
4. Find TubeArchivistMetadata in the Metadata section and install it
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:

• Collection display name
• TubeArchivist instance address
• TubeArchivist API key
• Overviews length (channels and videos descriptions)

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

3. Scrolling down, uncheck all metadata and image providers except TubeArchivist. (You won't find TubeArchivist in seasons providers, so just disable everything there)

4. 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

Build

1. To build this plugin you will need .Net 6.x.

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 for more information.