https://github.com/sillytavern/sillytavern-youtube-videos-server

Server plugin to extract a direct URL to a YouTube video using the yt-dlp library.
https://github.com/sillytavern/sillytavern-youtube-videos-server

plugin

Last synced: about 5 hours ago
JSON representation

Server plugin to extract a direct URL to a YouTube video using the yt-dlp library.

• Host: GitHub
• URL: https://github.com/sillytavern/sillytavern-youtube-videos-server
• Owner: SillyTavern
• License: agpl-3.0
• Created: 2024-04-25T21:55:12.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-05T21:45:42.000Z (7 months ago)
• Last Synced: 2024-05-05T22:34:06.712Z (7 months ago)
• Topics: plugin
• Language: TypeScript
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SillyTavern YouTube Player

**Also check out a companion UI extension! [SillyTavern-YouTube-Videos-UI](https://github.com/SillyTavern/SillyTavern-YouTube-Videos-UI)**

Server plugin to extract a direct URL to a YouTube video using the [yt-dlp](https://github.com/yt-dlp/yt-dlp) library.

## How to use

> [!TIP]

> Both endpoints also support providing the URL as a query parameter.

### Video URL

Send a message containing a video element with the source URL pre-wrapped with `/api/plugins/youtube/play/`.

For example

```html

```

### Video info

Query the `GET /api/plugins/youtube/info/` endpoint to fetch the video info.

```ts

interface VideoInfo {

    id: string;

    title: string;

    url: string;

    thumbnail: string;

    duration: number;

    description: string;

    uploader: string;

    view_count: number;

    upload_date: string;

}

```

Example: `GET /api/plugins/youtube/info/https://youtu.be/zFfL0y3zyfc`.

## How to install

1. Before you begin, make sure you set a config `enableServerPlugins` to `true` in the config.yaml file of SillyTavern.

2. Open a terminal in your SillyTavern directory, then run the following:

```bash

cd plugins

git clone https://github.com/SillyTavern/SillyTavern-YouTube-Videos-Server

```

3. Restart the SillyTavern server. The yt-dlp binary will be automatically downloaded from GitHub when you start the first video.

## How to build

Clone the repository, then run `npm install`.

```bash

# Debug build

npm run build:dev

# Prod build

npm run build

```

## License

AGPLv3