Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 5.97 KB

README.md

File metadata and controls

103 lines (74 loc) · 5.97 KB
Raw

TwitchAutomator

Check Server Check Client Publish Docker image Docker Pulls Server version Client version

1603661434863-wc

⚠️ SINCE MID 2021, A DOMAIN WITH HTTPS IS REQUIRED ⚠️

⚠️ SINCE THE NEW TYPESCRIPT SERVER, ALL USER DATA IS STORED IN /data/ ⚠️

Features

  • Automatic VOD recording pretty much the second the stream goes live, instead of checking it every minute like many other scripts do.
  • Cyclic recording, as in when a specified amount or storage per streamer is reached, the oldest stream gets deleted.
  • Tons of metadata, maybe too much. Stores info about games played, stream titles, duration, if the stream got muted from copyrighted music, etc.
  • Chapters (titles and games) are written to the final video file.
  • Video player with chat playback.
  • Video cutter with chapter display for easy exporting, also cuts the downloaded chat for synced rendering.
  • Notifications with optional speech when the website is open, get stream live notifications far earlier than the mobile app does.
  • Writes a losslesscut compatible csv file for the full VOD so you don't have to find all the games.
  • Uses ts instead of mp4 so if the stream or program crashes, the file won't be corrupted.
  • Optionally either dumps chat while capturing or downloads the chat file after it's done.
  • Basic tools for downloading any VOD or chat.
  • Can be set to automatically download the whole stream chat to a JSON file, to be used in my twitch-vod-chat webapp or automatically burned in with TwitchDownloader.
  • Basic webhook support for external scripting.
  • Notifications over the browser, telegram, and discord.

One high-profile streamer VOD of 10 hours at 1080p60 is about 30-50GB.

Post issues/help on the issues tab above. I already run an up to date version, so starting fresh might break stuff.

Migration from the PHP version

Move the folders cache, config, logs, payloads, and storage to a new folder called data in the root of the application, or place them anywhere else on the filesystem and use the --dataroot argument to tell the server where to look for them.

Docker setup

Reminder that i don't use docker myself on my capturing setup, so any specific errors to this are hard to test.

Docker hub

  1. Download the docker-compose.yml file and place it in a directory.
  2. Run docker-compose pull and docker-compose up -d to start it.
  3. Visit the webapp at localhost:8082
  4. Check stored vods in the /data/storage directory. Permissions might be an issue.

Hub: https://hub.docker.com/r/mrbrax/twitchautomator

The dockerhub build is preconfigured to be hosted at the root (/) and such, does not work when placed in a subdirectory.

Manual build

Run docker-compose up --build -d in the app directory. The docker-compose.yml file is required.

If you want the public webapp to have a custom base folder, you must provide BASE_URL and VUE_APP_BASE_URL in the environment variable settings.

Standalone setup

  1. Place the downloaded files in a separate folder from your www directory.
  2. Enter the root folder and run pip install -r requirements.txt
  3. Enter the /client-vue folder and run yarn install and yarn run build.
  4. Enter the /server folder and run yarn install and yarn run build.
  5. In the /server folder, run yarn run start to start the server in production mode.
  6. Go to the settings page and set up basic stuff, get api key from twitch dev site.
  7. Check the About page for subscription status.
  8. Optionally add cronjobs shown on the settings page.
  9. Check stored vods in the /data/storage directory. Permissions might be an issue.

Follow this guide to hackjob nginx: https://serversforhackers.com/c/nginx-php-in-subdirectory

Command line arguments

--port <number>

Specify port to run the server on.

--debug

Run the server in debug mode.

--dataroot <path>

Specify the data directory to use.

--home

Store the data in the home directory.

Main requirements

  • node.js 14+
  • npm and yarn
  • HTTPS enabled with a valid certificate on the default port 443
  • Python 3.7+
  • pip
  • FFmpeg
  • MediaInfo
  • TwitchDownloader (optional for chat downloading and burning)
  • Public facing webserver (nginx, apache, etc) for reverse proxy (optional)

pip packages