https://github.com/ziegmaster/ziegmachat
Websocket based chat application for Streamer.bot
https://github.com/ziegmaster/ziegmachat
chat-application electron gaming http-server javascript nodejs overlay streamerbot streaming twitch websocket widgets
Last synced: 3 months ago
JSON representation
Websocket based chat application for Streamer.bot
- Host: GitHub
- URL: https://github.com/ziegmaster/ziegmachat
- Owner: Ziegmaster
- License: mit
- Created: 2023-11-08T18:51:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T06:37:29.000Z (over 2 years ago)
- Last Synced: 2024-06-05T01:43:23.407Z (about 2 years ago)
- Topics: chat-application, electron, gaming, http-server, javascript, nodejs, overlay, streamerbot, streaming, twitch, websocket, widgets
- Language: JavaScript
- Homepage: https://twitch.tv/ziegmaster
- Size: 331 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
For streamers by a streamer
This program aims to improve the streaming experience. It independently hosts a chat widget that communicates with
Streamer.Bot via its websocket API.
All you have to do to see your chat in OBS is copy the link and paste it as a browser source in your scene.
Navigate to the widget directory
to see how to work with widget links and custom themes.
Hey streamer! This user guide is special for you! Don't miss it!
# 🎮 Game mode
ZiegmaChat has an extremely useful feature for streamers with only one screen.
In this mode, a second program window is launched, which can be freely placed anywhere on the screen.
After customizing its size and position, you can use a special switch to turn it into a gaming overlay.
> [!NOTE]
> There are games that force themselves to always be on top of everything. It is recommended to play them in windowed mode to see the overlay.
# 👍 Credits
Thanks to [BlackyWhoElse](https://github.com/BlackyWhoElse/streamer.bot-actions)
for the chat widget that was modified for correct usage in this project.
His themes are fully compatible. You can get them [here](https://github.com/BlackyWhoElse/streamer.bot-actions/tree/main/widget/chat/theme).
# 🌐 Developing and building from source
**Clone the project**
```console
git clone https://github.com/TrueZiegmaster/ZiegmaChat
```
```console
cd ./ZiegmaChat
```
**Install dependencies**
```console
npm install
```
**Test the application**
```console
npm start
```
**Install libraries if npm start fails**
```console
apt install libnss3-dev libgdk-pixbuf2.0-dev libgtk-3-dev libxss-dev
```
**Building the application**
```console
npm run build-windows
```
```console
npm run build-all
```
**Use electron-packager manually if you need other options.**
```console
electron-packager --help
```
**Install electron-packager if missing**
```console
npm install -g electron-packager --save-dev
```