Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.01 KB

README.md

File metadata and controls

16 lines (10 loc) · 1.01 KB
Raw

web-overlay

OBS's built-in overlay tools are too easy, so why not run a node.js app?

For best results, use with the CLR Browser Source plugin for OBS.

How to run

  1. Make sure you have node.js and Redis installed. Windows users will probably want to download it from MSOpenTech and follow these steps. Alternatively, just download the latest executable from https://github.com/rgl/redis/downloads. You will have to start the service manually the first time, but it will start up on boot afterward.

  2. Clone the repo change directory to the repo's root.

  3. Run npm install.

  4. Mac/Linux, run DEBUG=web-overlay bin/www to start the project. In Powershell, set an environment variable with $env:DEBUG = "web-overlay" before running node bin/www.