Add yt-dlp cookies configuration and update documentation (#63)

- Introduced YTDLP_COOKIES_PATH in .env.example, docker-compose files, and config.ts for specifying a cookies file path.
- Updated README.md with instructions on using cookies for yt-dlp to access private or premium content.
- Enhanced config command to display and modify the ytdlpCookiesPath parameter.
- Modified yt-dlp utility to utilize the specified cookies file if provided.

Author: ysdragon

.env.example

@@ -10,6 +10,9 @@ ADMIN_IDS = ["YOUR_USER_ID_HERE"] # A list of Discord user IDs that are consider
 VIDEOS_DIR = "./videos" # The local path where you store video files
 PREVIEW_CACHE_DIR = "./tmp/preview-cache" # The local path where your self-bot will cache video preview thumbnails
 
+# yt-dlp options
+YTDLP_COOKIES_PATH = "" # Path to cookies file for yt-dlp (Netscape format). Used for accessing age-restricted, private, or premium content. Leave empty if not needed.
+
 # Stream options
 STREAM_RESPECT_VIDEO_PARAMS = "false"  # This option is used to respect video parameters such as width, height, fps, bitrate, and max bitrate.
 STREAM_WIDTH = "1280" # The width of the video stream in pixels

README.md

@@ -143,6 +143,9 @@ ADMIN_IDS = ["YOUR_USER_ID_HERE"] # A list of Discord user IDs that are consider
 VIDEOS_DIR = "./videos" # The local path where you store video files
 PREVIEW_CACHE_DIR = "./tmp/preview-cache" # The local path where your self-bot will cache video preview thumbnails
 
+# yt-dlp options
+YTDLP_COOKIES_PATH = "" # Path to cookies file for yt-dlp (for accessing age-restricted or premium content)
+
 # Stream options
 STREAM_RESPECT_VIDEO_PARAMS = "false" # Respect original video parameters (width, height, fps, bitrate)
 STREAM_WIDTH = "1280" # The width of the video stream in pixels
@@ -164,6 +167,30 @@ SERVER_PASSWORD = "admin" # Password for the web interface (bcrypt hash is suppo
 SERVER_PORT = "8080" # Port number for the web server
 ```
 
+### Using Cookies with yt-dlp
+
+To access private, or premium content (like YouTube Premium videos), you can provide a cookies file to yt-dlp:
+
+1. **Export cookies from your browser** using a browser extension like:
+   - [Get cookies.txt LOCALLY](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc) (Chromium based browsers)
+   - [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) (Firefox based browsers)
+
+2. **Save the cookies file** (usually named `cookies.txt`) to a location accessible by the bot
+
+3. **Configure the path** in one of two ways:
+   - Set `YTDLP_COOKIES_PATH` in your `.env` file:
+     ```bash
+     YTDLP_COOKIES_PATH = "./cookies.txt"
+     ```
+   - Or use the config command while the bot is running:
+     ```
+     $config ytdlpCookiesPath ./cookies.txt
+     ```
+
+4. **Restart the bot** if you updated the `.env` file
+
+The cookies will be automatically used for all yt-dlp operations, allowing access to restricted content.
+
 ## Get Token ?
 Check the [Get token wiki](https://github.com/ysdragon/StreamBot/wiki/Get-Discord-user-token)
 

docker-compose-warp.yml

@@ -15,6 +15,9 @@ services:
       VIDEOS_DIR: "./videos" # The local path where you store video files
       PREVIEW_CACHE_DIR: "./tmp/preview-cache" # The local path where your self-bot will cache video preview thumbnails
 
+      # yt-dlp options
+      YTDLP_COOKIES_PATH: "" # Path to cookies file for yt-dlp (for accessing age-restricted or premium content)
+
       # Stream options
       STREAM_RESPECT_VIDEO_PARAMS: "false" # This option is used to respect video parameters such as width, height, fps, bitrate, and max bitrate.
       STREAM_WIDTH: "1280" # The width of the video stream in pixels

docker-compose.yml

@@ -15,6 +15,9 @@ services:
       VIDEOS_DIR: "./videos" # The local path where you store video files
       PREVIEW_CACHE_DIR: "./tmp/preview-cache" # The local path where your self-bot will cache video preview thumbnails
 
+      # yt-dlp options
+      YTDLP_COOKIES_PATH: "" # Path to cookies file for yt-dlp (for accessing age-restricted or premium content)
+
       # Stream options
       STREAM_RESPECT_VIDEO_PARAMS: "false" # This option is used to respect video parameters such as width, height, fps, bitrate, and max bitrate.
       STREAM_WIDTH: "1280" # The width of the video stream in pixels

src/commands/config.ts

@@ -54,6 +54,9 @@ export default class ConfigCommand extends BaseCommand {
 			`• videosDir: ${config.videosDir}`,
 			`• previewCacheDir: ${config.previewCacheDir}`,
 			"",
+			"**yt-dlp Options:**",
+			`• ytdlpCookiesPath: ${config.ytdlpCookiesPath || '(not set)'}`,
+			"",
 			"Use `config <parameter>` to view a specific parameter",
 			"Use `config <parameter> <value>` to change a parameter"
 		].join('\n');
@@ -137,6 +140,7 @@ export default class ConfigCommand extends BaseCommand {
 				// String parameters
 				case 'videosDir':
 				case 'previewCacheDir':
+				case 'ytdlpCookiesPath':
 					(config as any)[key] = value;
 					await this.sendSuccess(context.message, `Set ${key} to \`${value}\``);
 					logger.info(`Config updated: ${key} = ${value}`);

src/config.ts

@@ -77,6 +77,9 @@ export default {
 	videosDir: process.env.VIDEOS_DIR ? process.env.VIDEOS_DIR : './videos',
 	previewCacheDir: process.env.PREVIEW_CACHE_DIR ? process.env.PREVIEW_CACHE_DIR : './tmp/preview-cache',
 
+	// yt-dlp options
+	ytdlpCookiesPath: process.env.YTDLP_COOKIES_PATH ? process.env.YTDLP_COOKIES_PATH : '',
+
 	// Stream options
 	respect_video_params: process.env.STREAM_RESPECT_VIDEO_PARAMS ? parseBoolean(process.env.STREAM_RESPECT_VIDEO_PARAMS) : false,
 	width: process.env.STREAM_WIDTH ? parseInt(process.env.STREAM_WIDTH) : 1280,

src/utils/yt-dlp.ts

@@ -6,6 +6,7 @@ import crypto from "node:crypto";
 import got from "got";
 import { YTFlags } from "../types/index.js";
 import logger from "./logger.js";
+import config from "../config.js";
 import { spawn } from "node:child_process";
 
 let determinedFilename: string;
@@ -43,6 +44,13 @@ const exePath = nodePath.resolve(scriptsPath, filename);
 
 function args(url: string, options: Partial<YTFlags>): string[] {
 	const optArgs: string[] = [];
+	
+	// Add cookies file if configured
+	if (config.ytdlpCookiesPath && existsSync(config.ytdlpCookiesPath)) {
+		optArgs.push('--cookies');
+		optArgs.push(config.ytdlpCookiesPath);
+	}
+	
 	for (const [key, val] of Object.entries(options)) {
 		if (val === null || val === undefined) {
 			continue;