Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/globidev/twitch-irc
A base for working with Twitch IRC chatrooms
https://github.com/globidev/twitch-irc
irc plugin-engine twitch
Last synced: about 1 month ago
JSON representation
A base for working with Twitch IRC chatrooms
- Host: GitHub
- URL: https://github.com/globidev/twitch-irc
- Owner: Globidev
- License: bsd-3-clause
- Created: 2015-01-01T17:57:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-08T17:39:07.000Z (almost 9 years ago)
- Last Synced: 2024-11-06T06:43:44.790Z (3 months ago)
- Topics: irc, plugin-engine, twitch
- Language: Haskell
- Homepage:
- Size: 52.7 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Twitch-irc
=========
An extensible IRC relay application for [twitch.tv](http://www.twitch.tv/) chat rooms
## Motivation
As **streaming** becomes more and more popular, the need for **community centered applications** increases.
The world's leading video platform and community for gamers delivers over **10 billion messages** a day with its chat service ([source](http://blog.twitch.tv/2015/12/twitch-engineering-an-introduction-and-overview)).
A lot of existing tools revolve around this IRC-based service and this is why we should ease the process of making such tools.
This project aims to provide a robust base to work with twitch's IRC chat rooms.
## Usage
With docker :whale::
```sh
docker run --rm -it \
globidocker/twitch-irc channel script
```
### Examples
3 scripts are provided as a proof of extensibility
##### Echo
```sh
twitch-irc day9tv twitch-irc-echo
```
[This simple script](https://github.com/Globidev/twitch-irc/blob/master/scripts%2FEcho%2FMain.hs) will just display IRC messages on the standard output
##### Websocket
```sh
twitch-irc lirik twitch-irc-websocket [port]
```
[This script](https://github.com/Globidev/twitch-irc/blob/master/scripts%2FWebsocket%2FMain.hs) will relay private messages with a websocket server listening on the port `port`
You can subscribe to specific channels using the connection request's path `ws://host:port/channel`
This is the script used by [twitch-cast](https://github.com/best-coloc-ever/twitch-cast) and is available at `ws://datcoloc.com/chat/channel`
##### X11
```sh
twitch-irc your-channel twitch-irc-x11
```
Inspired by the social experiment [Twitch plays Pokémon](https://www.wikiwand.com/en/Twitch_Plays_Pok%C3%A9mon)
[This script](https://github.com/Globidev/twitch-irc/blob/master/scripts%2FX11%2FMain.hs) makes use of the X11 library to forward specific channel messages as keycodes to a X11 window.
The chat can send game inputs!
## Building
with [Haskell's stack](http://docs.haskellstack.org/en/stable/README.html):
```sh
stack setup
stack build --copy-bins
```