felixfoertsch/tubearchivist-jf-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source 
Update references to point to the new repository
This commit is contained in:
DarkFighterLuke
2024-04-17 22:48:55 +02:00
committed by GitHub
parent 347b2131db
commit 6d5c0b86b2
1 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -13
View File
@@ -1,7 +1,7 @@
<h1 align="center">Jellyfin TubeArchivist Plugin</h1>
<p align="center">
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/DarkFighterLuke/TubeArchivistMetadata/master/images/logo.png"/>
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/tubearchivist/tubearchivist-jf-plugin/master/images/logo.png"/>
<br/>
</p>
@@ -27,17 +27,18 @@ The plugin interacts with TubeArchivist APIs to fetch videos and channels metada
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/DarkFighterLuke/TubeArchivistMetadata/raw/master/manifest.json`
![Add repository](https://github.com/DarkFighterLuke/TubeArchivistMetadata/assets/31162436/bc291599-dc5b-4f44-b401-ebf20c016d72)
- Repository URL: `https://github.com/tubearchivist/tubearchivist-jf-plugin/raw/master/manifest.json`
![Add repository](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/b0216b21-79c4-445b-8cf1-fbf6b138dee0)
3. Go to the `Catalog` tab
4. Find `TubeArchivistMetadata` in the `Metadata` section and install it
![Find plugin](https://github.com/DarkFighterLuke/TubeArchivistMetadata/assets/31162436/86897215-bac5-4cef-8bd3-ffec731b0875)
![Find plugin](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/86897215-bac5-4cef-8bd3-ffec731b0875)
5. Restart Jellyfin to apply the changes
### From ZIP in GitHub releases
1. Download the latest available release (`TubeArchivist-*.zip`) from the repository releases section
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
3. Restart Jellyfin to apply the changes
## Configuration
<p>This plugin requires that you have already an instance of TubeArchivist up and running.</p>
@@ -49,7 +50,8 @@ Once installed, you have to configure the following parameters in the plugin con
<li>Overviews length (channels and videos descriptions)</li>
</ul>
![Plugin configuration](https://github.com/DarkFighterLuke/TubeArchivistMetadata/assets/31162436/706c1eee-c769-4f40-9909-08198b7ba255)
![Plugin configuration](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/d34464ea-ddfb-44b3-9d3e-5d5974956c58)
## Use the plugin
<p>Using the plugin is very simple. Let's start from the beginning:</p>
@@ -57,9 +59,10 @@ Once installed, you have to configure the following parameters in the plugin con
_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._ <br>
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/DarkFighterLuke/TubeArchivistMetadata/assets/31162436/1eca534e-0929-4134-8587-3cff0009f618)
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
![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
## Build
@@ -67,10 +70,10 @@ _NOTE: If you are using Docker containers, it is important to mount the TubeArch
2. Build plugin with following command
```
dotnet publish Jellyfin.Plugin.TubeArchivistMetadata --configuration Release --output bin
dotnet publish Jellyfin.Plugin.tubearchivist-jf-plugin --configuration Release --output bin
```
3. Place the dll-file in the `plugins/TubeArchivistMetadata` folder (you might need to create the folders) of your Jellyfin installation
3. Place the dll-file in the `plugins/tubearchivist-jf-plugin` folder (you might need to create the folders) of your Jellyfin installation
## License