globidev / twitch-irc

A base for working with Twitch IRC chatrooms

Twitch-irc

An extensible IRC relay application for 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).
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 🐳:

docker run --rm -it \
    globidocker/twitch-irc channel script

Examples

3 scripts are provided as a proof of extensibility

Echo

twitch-irc day9tv twitch-irc-echo

This simple script will just display IRC messages on the standard output

Websocket

twitch-irc lirik twitch-irc-websocket [port]

This script 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 and is available at ws://datcoloc.com/chat/channel

X11

twitch-irc your-channel twitch-irc-x11

Inspired by the social experiment Twitch plays Pokémon

This script 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:

stack setup
stack build --copy-bins

twitch-irc's Issues

Add support for eventchats

Some channels on Twitch use eventchat which means that message delivery is done by a dedicated websocket server.
This is the case for very crowded channels like twitch.tv/riotgames or esports related channels in general

Adding support for those channels would be nice!

automate C compiling

Library foobar
-- ...
-- The C source files to compile, in that order
C-sources: cbits/foobar.c, cbits/foobaz.c
-- The location of the header files
Include-dirs: include
-- The header files to be included
Includes: foobar.h, foobaz.h
-- Header files to install
Install-includes: foobar.h, foobaz.h

the name of the folder must match the project name in your .cabal

Stack team fixed the bug with stack-ide yesterday, but this morning, I still had some trouble to get it work. Turns out the name of the project 'twich-hs' (defined in your .cabal) must be the same as the folder name