/twitch-video-commands

Plays a video on stream whenever a command is sent on twitch chat

Primary LanguageTypeScript

twitch-video-commands

Plays a video on stream whenever a command is sent on twitch chat

Supports cooldown, has a command to show all available video commands and more

Setup in OBS (when you have the server URL)

  1. Add a new Browser Source
  2. Set the server URL as the URL field
  3. (optional) Add a chroma key filter so the videos can have a transparent background

Commands Configuration

  1. Copy parameters.example.ts to parameters.ts and edit it as follows:
  2. Follow the comments to configure the parameters of the application
  3. To setup the video commands, add entries to the commands array, following the example
    • You should place your videos in the /src/public/resources directory

Server and authentication Configuration

  1. Copy .env.example to .env and edit as follows:
  2. Set up your twitch bot username, passwords and the server port
    • Example: TWITCH_BOT_PASSWORD="oauth:xxx"
    • Example: TWITCH_CHANNELS="["#testchannel"]"

Building and Running the application

  1. Install node.js, yarn
  2. Run yarn to install the project dependencies
  3. To build the app, navigate to the project root and run yarn build
  4. To run the app, navigate to the project root and run yarn start
  5. In development, you can combine both of the above steps by running yarn dev. This will also auro-reload the app on any change
    • For this to run, you need to run once yarn global add nodemon ts-node
  6. The server will run on the port specified

Project structure

  1. src/app.ts: the server, which runs with node
  2. src/public: the public files, which will be used by the front-end