Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hperrin/stream-overlay
Show borderless, transparent, click-through browser windows for streaming on Windows and Linux.
https://github.com/hperrin/stream-overlay
streaming twitch
Last synced: 3 months ago
JSON representation
Show borderless, transparent, click-through browser windows for streaming on Windows and Linux.
- Host: GitHub
- URL: https://github.com/hperrin/stream-overlay
- Owner: hperrin
- License: apache-2.0
- Created: 2022-05-01T03:30:12.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T19:37:38.000Z (10 months ago)
- Last Synced: 2024-03-18T21:13:08.142Z (10 months ago)
- Topics: streaming, twitch
- Language: TypeScript
- Homepage:
- Size: 1.33 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/hperrin/stream-overlay/releases) 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.
```sh
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.
```sh
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:
```sh
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.
```sh
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