tampermonkey scripts for streamlink

readme.md

Streamlink Tampermonkey Scripts

This repository contains a collection of scripts designed to be used with Tampermonkey to launch Streamlink for recording streams. The scripts are compatible with both macOS and Windows, assuming that Streamlink is already installed on the system.

Scripts

streamlink.js

This script detects the operating system and the presence of Streamlink, then launches Streamlink to record the stream.

macos_script.sh

A shell script for macOS that launches Streamlink to record a stream.

windows_script.bat

A batch script for Windows that launches Streamlink to record a stream.

macos.js

assumes using macOS and streamlink is alreaady installed

windows.js

assumes using windows and streamlink is alreaady installed

Prerequisites

• Streamlink must be installed on your system.
• Tampermonkey browser extension must be installed.

Usage

1. Open the stream you want to record in your browser.
2. The Tampermonkey script will provide a button to help launch streamlink for that URL to start recording.

macOS.js

// ==UserScript==
// @name         Launch Terminal and Streamlink
// @namespace    http://tampermonkey.net/
// @version      0.1
// @description  button for twitch that launches terminal and streamlink
// ==/UserScript==

(function() {
    'use strict';

    // Get auth token from cookies
    const authToken = document.cookie.split("; ").find(item => item.startsWith("auth-token="))?.split("=")[1];

    // Get URL (you might want to modify this part to accurately grab the correct URL)
    const url = window.location.href;

    // Create an AppleScript to launch Terminal and execute streamlink command
    const appleScript = `
        tell application "Terminal"
            activate
            do script "streamlink --twitch-api-header=Authorization=OAuth ${authToken} --record '/Users/{path}/streamlink/{author}-{category}-{title}-{time:%Y%m%d}.ts' ${url} best"
        end tell
    `;

    // Use a hidden form to submit the AppleScript to the OS
    const form = document.createElement('form');
    form.method = 'POST';
    form.action = 'javascript:(function(){var w=window.open();w.document.open();w.document.write(\'<script>\' + appleScript + \'</script>\');})()';
    document.body.appendChild(form);
    form.submit();
})();

streamlink.js

// Detect Browser
function getBrowserInfo() {
    const userAgent = navigator.userAgent;
    let browserName = "Unknown";

    if (userAgent.indexOf("Firefox") > -1) {
        browserName = "Mozilla Firefox";
    } else if (userAgent.indexOf("Chrome") > -1) {
        browserName = "Google Chrome";
    } else if (userAgent.indexOf("Safari") > -1) {
        browserName = "Apple Safari";
    } else if (userAgent.indexOf("MSIE") > -1 || !!document.documentMode) {
        browserName = "Internet Explorer";
    }

    return browserName;
}

// Detect OS
function getOSInfo() {
    const userAgent = navigator.userAgent;
    let osName = "Unknown";

    if (userAgent.indexOf("Win") > -1) {
        osName = "Windows";
    } else if (userAgent.indexOf("Mac") > -1) {
        osName = "MacOS";
    } else if (userAgent.indexOf("X11") > -1) {
        osName = "UNIX";
    } else if (userAgent.indexOf("Linux") > -1) {
        osName = "Linux";
    }

    return osName;
}

// Check if Streamlink is installed
function isStreamlinkInstalled() {
    // This is a placeholder function. Actual implementation may vary.
    // Streamlink is a command-line tool, so checking its installation from a browser is not straightforward.
    // You might need to use a server-side script to check this.
    return false;
}

// Get Twitch URL and Auth Code
function getTwitchInfo() {
    const twitchURL = prompt("Enter the Twitch URL:");
    const authCode = prompt("Enter the Auth Code:");

    return { twitchURL, authCode };
}

// Pass information to Streamlink to record the stream
function recordStream(twitchURL, authCode) {
    if (!isStreamlinkInstalled()) {
        alert("Streamlink is not installed.");
        return;
    }

    const command = `streamlink --twitch-api-header=Authorization=OAuth ${authCode} ${twitchURL} best`;
    console.log("Run the following command in your terminal to record the stream:");
    console.log(command);
}

// Main function
function main() {
    const browserInfo = getBrowserInfo();
    const osInfo = getOSInfo();
    const { twitchURL, authCode } = getTwitchInfo();

    console.log(`Browser: ${browserInfo}`);
    console.log(`OS: ${osInfo}`);
    console.log(`Twitch URL: ${twitchURL}`);
    console.log(`Auth Code: ${authCode}`);

    recordStream(twitchURL, authCode);
}

// Run the main function
main();

windows.js

const { exec } = require('child_process');
const readline = require('readline');
const path = require('path');

// Function to prompt user for input
const prompt = (query) => {
    const rl = readline.createInterface({
        input: process.stdin,
        output: process.stdout,
    });

    return new Promise((resolve) => rl.question(query, (ans) => {
        rl.close();
        resolve(ans);
    }));
};

(async () => {
    try {
        // Prompt for Twitch URL
        const twitchUrl = await new Promise((resolve, reject) => {
            exec('powershell -command "Add-Type -AssemblyName System.Windows.Forms; [System.Windows.Forms.Clipboard]::GetText()"', (error, stdout, stderr) => {
            if (error) {
                reject(`Error: ${error.message}`);
                return;
            }
            if (stderr) {
                reject(`Stderr: ${stderr}`);
                return;
            }
            const url = stdout.trim();
            if (url.startsWith('https://www.twitch.tv/')) {
                resolve(url);
            } else {
                reject('The URL is not a valid Twitch URL.');
            }
            });
        });

        // Prompt for Twitch Auth Code
        const authCode = await new Promise((resolve, reject) => {
            exec('powershell -command "Add-Type -AssemblyName System.Windows.Forms; [System.Windows.Forms.Clipboard]::GetText()"', (error, stdout, stderr) => {
            if (error) {
                reject(`Error: ${error.message}`);
                return;
            }
            if (stderr) {
                reject(`Stderr: ${stderr}`);
                return;
            }
            const code = stdout.trim();
            if (code) {
                resolve(code);
            } else {
                reject('Failed to retrieve the auth code from the clipboard.');
            }
            });
        });

        // Prompt for download path
        const downloadPath = await prompt('Enter the download path: ');

        // Construct the streamlink command
        const command = `streamlink --twitch-api-header "Authorization=OAuth ${authCode}" ${twitchUrl} best -o ${path.join(downloadPath, 'recording.ts')}`;

        // Execute the command
        exec(command, (error, stdout, stderr) => {
            if (error) {
                console.error(`Error: ${error.message}`);
                return;
            }
            if (stderr) {
                console.error(`Stderr: ${stderr}`);
                return;
            }
            console.log(`Output: ${stdout}`);
        });
    } catch (error) {
        console.error(`Error: ${error.message}`);
    }
})();