Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tubearchivist/tubearchivist-jf-plugin
Metadata for your TubeArchivist library on Jellyfin.
https://github.com/tubearchivist/tubearchivist-jf-plugin
Last synced: 6 days ago
JSON representation
Metadata for your TubeArchivist library on Jellyfin.
- Host: GitHub
- URL: https://github.com/tubearchivist/tubearchivist-jf-plugin
- Owner: tubearchivist
- License: gpl-3.0
- Created: 2024-02-29T22:15:47.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-14T13:42:01.000Z (about 2 months ago)
- Last Synced: 2024-09-15T03:55:07.862Z (about 2 months ago)
- Language: C#
- Homepage:
- Size: 1.32 MB
- Stars: 101
- Watchers: 6
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jellyfin - tubearchivist-jf-plugin - Metadata provider for TubeArchivist. (🧩 Plugins)
README
Jellyfin TubeArchivist Plugin
> [!IMPORTANT]
> Jellyfin 10.9.1 has been finally released and since starting with the version 1.3.0 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.
## 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)
- Playback synchronization settings discussed in the Playback synchronization paragraph
## 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
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
## 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 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 plugin configuration you will find these settings:
In the text field you can specify one Jellyfin username to synchronize data of to TubeArchivist.
### TubeArchivist->Jellyfin synchronization
This kind of synchronization is done using a Jellyfin scheduled task that regularly synchronizes data from TubeArchivist API to Jellyfin.
In the plugin configuration you will find these settings:
In the first text field you can specify one or more Jellyfin usernames to update data for.
In the second field you can specify the interval in seconds the task should run at, so that you can choose according to your system requirements. The lower is the interval the higher will be the resources consuption on your system.
## Build
1. To build this plugin you will need [.Net 8.x](https://dotnet.microsoft.com/download/dotnet/8.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.