Jellyfin TubeArchivist Plugin
About
This plugin adds the metadata provider for TubeArchivist.
This plugin offers improved flexibility and native integration with Jellyfin compared to tubearchivist-jf solution.
This solution runs also more smoothly than the cited one since it is direcly integrated in Jellyfin and it is not based on strict folder paths on the disk.
Furthermore, it allows to configure a custom collection name.
How it works
The media organization is the same used in tubearchivist-jf, so the collection will be 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)
- Go to
Dashboard -> Pluginsand select theRepositoriestab - Add a new repository with the following details:
- Repository name:
TubeArchivistMetadata - Repository URL:
https://github.com/DarkFighterLuke/TubeArchivistMetadata/raw/master/manifest.json
- Go to the
Catalogtab - Find
TubeArchivistMetadatain theMetadatasection and install it - Restart Jellyfin to apply the changes
From ZIP in GitHub releases
- Download the latest available release (
TubeArchivist-*.zip) from the repository releases section - Extract the contained files in the
plugins/TubeArchivistMetadatafolder (you might need to create the folders) of your Jellyfin installation - 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.
- Go to
Dashboard -> Librariesand add a media library - In the form select
Showsas Content type, set a display name for the library and set the TubeArchivist media folder in theFolderssection - Scrolling down, uncheck all metadata and image providers except
TubeArchivist. (You won't find TubeArchivist in seasons providers, so just disable everything there) - 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
-
To build this plugin you will need .Net 6.x.
-
Build plugin with following command
dotnet publish Jellyfin.Plugin.TubeArchivistMetadata --configuration Release --output bin
- Place the dll-file in the
plugins/TubeArchivistMetadatafolder (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.
