Skip to content

Commit

Permalink
Added info
Browse files Browse the repository at this point in the history
  • Loading branch information
FDMX2 committed Sep 20, 2022
1 parent 3fb2f8c commit 13ccf4e
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# MessageForwarder
A simple websocket server forwarding chat messages received from a livestream chat
A simple websocket server forwarding chat messages received from a livestream chat.

It is made to be used in combination with Twitch Heatmap Chat (https://github.com/FDMX2/Twitch-Heatmap-Chat)

## How it works:
Download the latest executable here (https://github.com/FDMX2/MessageForwarder/releases) and start it or run the main.py you find in the MsgForwarder folder (only if you have python 3.6 or higher installed).

The server is now ready to serve messages from livestreams. You can connect via the default port 13254.

### Example usage with Twitch Heatmap Chat
1. Open the Twitch Heatmap Chat (https://fdmx2.github.io/Twitch-Heatmap-Chat/) in your browser.
2. As Channel name enter the webscoket address and livestream url separated by | like so:
```
ws://ws_address|LIVESTREAM_URL
```
For example if you run the server on the same machine:
```
ws://127.0.0.1:13254|https://www.youtube.com/watch?v=VIDEOID
```

## It uses:
- Websocket Server (https://github.com/Pithikos/python-websocket-server) to simplify websocket handling
- Chat downloader (https://github.com/xenova/chat-downloader) to receive the livestream messages

## License

The MIT License

Copyright (c) 2022 FDMX2 @ github

0 comments on commit 13ccf4e

Please sign in to comment.