Introduction to YouTube-Agent.bundle for Plex
The YouTube-Agent.bundle is a powerful tool designed for managing downloaded YouTube videos within Plex, a popular media server application. Serving as a metadata agent, it enriches your movie and TV series library by fetching metadata directly from YouTube using the unique video ID found in the filenames of your stored videos.
Key Features
-
Metadata Fetching: The primary function of this agent is to pull video metadata based on YouTube video IDs. It automatically obtains information such as the title, summary, poster, rating, and more, allowing for a well-organized media library.
-
File Naming Format: For seamless metadata retrieval, the YouTube video ID must be part of the filename or folder name. Acceptable formats include
[xxxxxxxx]
,[youtube-xxx]
,[YouTube-xxx]
, and[Youtube-xxx]
. -
Compatibility with .info.json Files: The agent can also extract metadata from
.info.json
files directly, which can reduce the number of API requests required. -
Supports Multiple Formats: It works well across different formats, ensuring you can catalog various video files without issues.
Installation Instructions
To make the plugin operational:
- Place the plugin within the
Plex Media Server/Plug-ins
folder specific to your operating system. - You may find step-by-step guidance for installation on the Plex support site.
The plugin is available via download as a zip file from GitHub. After downloading, extract and rename the folder to Youtube-Agent.bundle
, and then place it in the correct plugin directory. Restarting Plex Media Server is crucial for the changes to take effect.
Enabling the Agent for Your Library
When setting up a new library or modifying an existing one within Plex, be sure to:
- Select
Manage Library
and thenEdit
. - Under the
Advanced
tab, choose eitherYoutubeMovie
orYouTubeSeries
as the agent, corresponding to your library’s needs.
Usage Overview
For users interested in downloading playlists, the plugin integrates well with youtube-dl
, a command-line tool for downloading YouTube videos. Key tips for downloading include:
- Use
--restrict-filenames
to avoid complications with file systems, especially on Windows. - Employ
--write-info-json
to write metadata information to a local file, minimizing the necessity for repeated API requests.
YouTube API Key
To maximize the plugin's potential without exhausting the default API's request allotment, users are advised to register for their own YouTube API key. Detailed instructions for obtaining this key are provided in the README, involving steps through the Google Developer Console.
Troubleshooting and Support
Troubleshooting involves ensuring you have the latest versions of the Absolute Series Scanner and YouTube-Agent, and you're advised to clear existing logs and capture new ones to assist in diagnosing issues. Support is available through GitHub's issue tracker or forum discussions dedicated to this agent.
Donations
Support for this project can be rendered through donations, with various options available such as PayPal links, ensuring continuous development and improvements to the YouTube-Agent.bundle.
By seamlessly integrating YouTube content into your Plex library, the YouTube-Agent.bundle stands as an indispensable tool for media enthusiasts looking to enhance their collection with rich metadata and streamlined management practices.