https://github.com/distubejs/yt-dlp

yt-dlp plugin for DisTube
https://github.com/distubejs/yt-dlp

Last synced: about 2 months ago
JSON representation

yt-dlp plugin for DisTube

• Host: GitHub
• URL: https://github.com/distubejs/yt-dlp
• Owner: distubejs
• License: mit
• Created: 2022-01-27T14:02:01.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-18T11:15:14.000Z (over 2 years ago)
• Last Synced: 2024-05-05T13:22:30.093Z (8 months ago)
• Language: TypeScript
• Size: 1.75 MB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


    

  

  


    

    

    

    

  



# @distube/yt-dlp

[yt-dlp](https://github.com/yt-dlp/yt-dlp) extractor plugin for [DisTube.js.org](https://distube.js.org).

# Feature

- Support [900+ sites](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md) using [yt-dlp](https://github.com/yt-dlp/yt-dlp)

# Requirement

- [python](https://www.python.org/)

# Installation

```sh

npm install @distube/yt-dlp@latest

```

# Documentation

### new YtDlpPlugin([YtDlpPluginOptions])

Create a DisTube's `ExtractorPlugin` instance.

- `YtDlpPluginOptions.update` (`boolean`): Default is `true`. Update the yt-dlp binary when the plugin is initialized.

# Usage

```js

const Discord = require("discord.js");

const client = new Discord.Client();

const { DisTube } = require("distube");

const { YtDlpPlugin } = require("@distube/yt-dlp");

const distube = new DisTube(client, {

  plugins: [new YtDlpPlugin({ update: true })],

});

```