title	StreamBot
emoji	🎬
colorFrom	blue
colorTo	purple
sdk	docker
app_port	3000
suggested_hardware	cpu-basic
license	mit
short_description	Discord video streaming bot
pinned	false

StreamBot

A powerful Discord self-bot for streaming videos from multiple sources with a web management interface

📑 Table of Contents

• ✨ Features
• 📋 Requirements
• 🚀 Installation
• 🎮 Usage
• 🐳 Docker Setup
• 🎯 Commands
• ⚙️ Configuration
• 🌐 Web Interface
• 🤝 Contributing
• ⚠️ Disclaimer
• 📝 License

✨ Features

• 📁 Local Video Streaming: Stream videos from your local videos folder
• 🎬 YouTube Integration: Stream YouTube videos with smart search functionality
• 📺 YouTube Live Streams: Direct streaming support for YouTube live content
• 🟣 Twitch Support: Stream Twitch live streams and video-on-demand (VODs)
• 🔗 Direct URL Streaming: Stream from any URL supported by yt-dlp (thousands of video sites including Vimeo, Dailymotion, Facebook, Instagram, news sites, and more)
• 🎵 Queue System: Queue multiple videos with auto-play and skip functionality
• 🌐 Web Management Interface: Full-featured web dashboard for video library management
• 📤 Video Upload: Upload videos through the web interface or download from remote URLs
• 🖼️ Video Previews: Generate and view thumbnail previews for all videos
• ⚙️ Runtime Configuration: Adjust streaming parameters and bot settings during runtime

📋 Requirements

• Bun v1.1.39+ (recommended) or Node.js v21+
• FFmpeg (the bot will attempt to install it automatically if missing, but manual installation is recommended)
• yt-dlp (automatically downloaded and updated by the bot)

💡 Optional

• 🎮 GPU with hardware acceleration for improved streaming performance
• 🌐 High-speed internet for remote video streaming and downloads
• 💾 Sufficient disk space for video storage and cache

🚀 Installation

This project is hosted on GitHub.

1. Clone the repository:

git clone https://github.com/ysdragon/StreamBot
cd StreamBot

2. Install dependencies:

With Bun (recommended):

bun install

With npm:

npm install

3. Configure environment:

   • Copy .env.example to .env
   • Update the configuration values (see ⚙️ Configuration section)
   • See the wiki for instructions on obtaining your Discord token

4. Setup complete! 🎉 Required directories for videos and cache will be created automatically on first run.

🎮 Usage

🚀 Starting the Bot

With Bun (recommended):

bun run start

With Node.js:

npm run build
npm run start:node

With web interface enabled: Set SERVER_ENABLED=true in your .env file. The web interface runs alongside the bot automatically.

To run only the web interface without the bot:

bun run server       # With Bun
npm run server:node  # With Node.js (after building)

📹 Video Playback

All videos are played through a queue system that automatically advances to the next video when the current one ends.

The play command automatically detects the input type:

• 📁 Local files from your VIDEOS_DIR
• 🎬 YouTube videos (by URL or search query)
• 🟣 Twitch streams (live or VOD)
• 🔗 Any URL supported by yt-dlp

Use ytsearch to find YouTube videos, then play with the results to stream them. Use list to browse your local video collection.

🐳 Docker Setup

StreamBot provides ready-to-use Docker configurations for easy deployment.

📦 Standard Deployment

1. Create project directory:

mkdir streambot && cd streambot

2. Download Docker Compose configuration:

wget https://raw.githubusercontent.com/ysdragon/StreamBot/main/docker-compose.yml

3. Configure environment:

   • Edit docker-compose.yml to set your environment variables
   • Ensure video storage directories are properly mounted

4. Launch StreamBot:

docker compose up -d

☁️ Cloudflare WARP Deployment

For enhanced network capabilities with Cloudflare WARP:

1. Download WARP configuration:

wget https://raw.githubusercontent.com/ysdragon/StreamBot/main/docker-compose-warp.yml

2. Configure WARP settings:

   • Add your WARP license key to docker-compose-warp.yml
   • Update Discord token and other required environment variables

3. Launch with WARP:

docker compose -f docker-compose-warp.yml up -d

⚠️ Note: The web interface is not available in WARP mode because the WARP container uses network isolation that prevents external access to the web server port.

🎯 Commands

📺 Playback Commands

Command	Description	Aliases
play <video_name|url|search_query>	Play local video, URL, or search YouTube videos
ytsearch <query>	Search for videos on YouTube
stop	Stop current video playback and clear queue	leave, s
skip	Skip the currently playing video	next
queue	Display the current video queue
list	Show available local videos

🔧 Utility Commands

Command	Description	Aliases
status	Show current streaming status
preview <video_name>	Generate preview thumbnails for a video
ping	Check bot latency
help	Show available commands

🛡️ Administration Commands

Command	Description	Aliases
config [parameter] [value]	View or adjust bot configuration parameters (Admin only)	cfg, set

⚙️ Configuration

StreamBot is configured through environment variables in a .env file. Copy .env.example to .env and modify the values as needed.

🔐 Discord Self-Bot Configuration

# Required: Your Discord self-bot token
# See: https://github.com/ysdragon/StreamBot/wiki/Get-Discord-user-token
TOKEN="YOUR_BOT_TOKEN_HERE"

# Command prefix for bot commands
PREFIX="$"

# Discord server where the bot will operate
GUILD_ID="YOUR_SERVER_ID"

# Channel where bot will respond to commands
COMMAND_CHANNEL_ID="COMMAND_CHANNEL_ID"

# Voice/video channel where bot will stream
VIDEO_CHANNEL_ID="VIDEO_CHANNEL_ID"

# Admin user IDs - comma-separated or JSON array format
# Examples:
#   ADMIN_IDS="123456789,987654321"
#   ADMIN_IDS=["123456789","987654321"]
ADMIN_IDS=["YOUR_USER_ID_HERE"]

# Discord acknowledgement behavior
DISCORD_REACTIONS_ENABLED=""          # Leave empty for profile default; set false if reactions time out
DISCORD_SEND_TIMEOUT_MS=""            # Leave empty for 10000ms; nonzero values below 10000 are clamped; set 0 to wait forever
DISCORD_SUPPRESS_ABORT_WARNINGS=""    # Leave empty to log Discord send aborts while debugging

📁 File Management

# Directory where video files are stored
VIDEOS_DIR="./videos"

# Directory for caching video preview thumbnails
PREVIEW_CACHE_DIR="./tmp/preview-cache"

# Directory for temporary remote movie cache files
STREAM_REMOTE_CACHE_DIR="./tmp/remote-cache"

# Directory for temporary pre-transcoded playback files
STREAM_TRANSCODE_CACHE_DIR="./tmp/transcode-cache"

🍪 Content Source Configuration

# Path to browser cookies for accessing private/premium content
# Supports: YouTube Premium, age-restricted content, private videos
YTDLP_COOKIES_PATH=""

🎥 Streaming Configuration

# Video Quality Settings
STREAM_PROFILE=""                     # Leave empty for auto; use "hf-cpu-basic" to force Hugging Face CPU Basic settings
STREAM_RESPECT_VIDEO_PARAMS="false"  # Use original video parameters if true
STREAM_BITRATE_OVERRIDE="false"      # If true, use STREAM_BITRATE_KBPS even when respecting video params
STREAM_WIDTH="1280"                  # Output resolution width
STREAM_HEIGHT="720"                  # Output resolution height
STREAM_MAX_WIDTH="0"                 # Max width cap (0 = disabled)
STREAM_MAX_HEIGHT="0"                # Max height cap (0 = disabled)
STREAM_FPS="30"                      # Target frame rate

# Bitrate Settings (affects quality and bandwidth usage)
STREAM_BITRATE_KBPS="2000"           # Target bitrate (higher = better quality)
STREAM_MAX_BITRATE_KBPS="2500"       # Maximum allowed bitrate

# Performance & Encoding
STREAM_HARDWARE_ACCELERATION="false" # Use GPU acceleration if available
STREAM_VIDEO_CODEC="H264"            # Codec: H264, H265, VP8, VP9, AV1
STREAM_FFMPEG_VIDEO_ENCODER=""       # Optional FFmpeg encoder override, e.g. h264_nvenc
STREAM_FFMPEG_THREADS="0"            # Optional FFmpeg thread limit (0 = auto)
STREAM_NO_TRANSCODING="false"        # Skip video transcoding for already Discord-friendly sources
STREAM_PRETRANSCODE_BEFORE_PLAYBACK="false" # Pre-transcode before playback for smoother CPU-only VPS streaming

# Remote Source Cache
STREAM_FULL_CACHE_REMOTE="false"     # Fully cache remote HTTP movies before playback
STREAM_REMOTE_PREBUFFER_MB="200"     # Initial remote buffer size when full cache is disabled

# H.264/H.265 Encoding Preset (quality vs speed tradeoff)
# Options: ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow
STREAM_H26X_PRESET="ultrafast"

For Hugging Face CPU Basic Spaces, leave STREAM_PROFILE unset for auto-detection or set:

STREAM_PROFILE="hf-cpu-basic"

That profile defaults to 854x480, 24 FPS, 1400-2000 Kbps, two FFmpeg threads, and full remote cache. Pre-transcoding before playback is opt-in because it can delay a full movie by many minutes before Discord receives any video.

🌐 Web Interface Configuration

# Enable/disable the web management interface
SERVER_ENABLED="false"

# Web interface authentication
SERVER_USERNAME="admin"
SERVER_PASSWORD="admin"  # Plain text, bcrypt, or argon2 hash

# Web server port
SERVER_PORT="8080"

🍪 Using Cookies with yt-dlp

To access private or premium content (like YouTube Premium videos), you can provide a cookies file:

1. Export cookies from your browser using a browser extension:

   • Get cookies.txt LOCALLY (Chromium-based browsers)
   • 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 your .env file:

   YTDLP_COOKIES_PATH="./cookies.txt"

   Or use the config command at runtime:

   $config ytdlpCookiesPath ./cookies.txt
   

4. Restart the bot if you updated the .env file

🌐 Web Interface

When enabled (SERVER_ENABLED="true"), StreamBot provides a web-based management interface.

✨ Features

• 📋 Video Library Management: Browse your video collection with file sizes and detailed information
• 📤 Local File Upload: Upload videos directly with progress tracking
• 🌐 Remote URL Download: Download videos from URLs directly to your library
• 🖼️ Video Previews: Generate and view thumbnail screenshots from different parts of each video
• 🗑️ File Management: Delete videos from your library
• 📊 Video Metadata: View detailed information (duration, resolution, codec, etc.)

🔗 Access

After enabling and restarting the bot, access the interface at http://localhost:8080 (or your configured SERVER_PORT).

🤝 Contributing

Contributions are welcome! Feel free to:

• 🐛 Report bugs via issues
• 🔧 Submit pull requests
• 💡 Suggest new features

⚠️ Disclaimer

This bot may violate Discord's Terms of Service. Use at your own risk.

I disavow before Allah any unethical use of this project.

إبراء الذمة: أتبرأ من أي استخدام غير أخلاقي لهذا المشروع أمام الله.

📝 License

Licensed under MIT License. See LICENSE for details.