Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 1.76 KB

README.md

File metadata and controls

71 lines (44 loc) · 1.76 KB

SylphWeed's Stream Overlay

Borderless, transparent, click-through browser windows for streaming.

For example, you can show your Twitch chat and alerts on your display, over your game.

I made this app because I would often not notice my chat messages on my other monitor, and I'd prefer to have them come up on the display I'm looking at, rather than only in an OBS overlay. It's also great for single monitor streamers.

Download

Head over to the releases page to download the latest version.

Notes

Windows

You can check for updates through the system tray menu.

Linux

You need to be using X, not Wayland. Everything works in Wayland except click-through windows.

Development

After checking out the repo, run the following in the repo's folder.

npm install
cd app/app
npm install
cd ../..
npm start

Under most circumstances, it's easiest to just Ctrl+C that instance and run npm start again, instead of running watchers.

When you've completed your changes and are ready to package it up, run the following.

npm run clean
npm run build
npm run package:windows # or package:linux

Flatpak

You need to install pipx and then the Flatpak node tools:

git clone https://github.com/flatpak/flatpak-builder-tools.git
cd flatpak-builder-tools/node/
pipx install .

To build the flatpak and install it locally (on Linux), run the following after the above commands.

npm run package:flatpak

Support Me

You can support me directly by supporting my software company, SciActive, on Patreon:

https://www.patreon.com/sciactive

You can also support me for free by following me on Twitch:

https://www.twitch.tv/sylphweed