Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.07 KB

README.md

File metadata and controls

83 lines (61 loc) · 2.07 KB
Raw

Twitch Chat in Elm

This project was done in order to test whether Elm can be used to replace certain well established pieces of Javascript. One of these is the Twitch chat. Recently, Twitch has upgraded their chat servers to also support WebSockets.

Features

  • Receiving messages
  • Sending messages
  • Emotes
  • Subscriber badges
  • Turbo badges
  • Mod badges
  • Global mod badges
  • Admin badges
  • Staff badges
  • Broadcaster badges
  • Bits badges (wrong implementation, will have to use the new badges.twitch.tv endpoint)
  • Cheers
  • Resubscribe notices
  • Subscribe notices
  • Timeout/ban actions
  • /me actions
  • Emote picker
  • Viewer list
  • @ tagging

JSONP

The recommended way of consuming the Twitch API is JSONP. elm-lang/http has no way of using JSONP. That's why this project includes some Native Elm code to solve this.

Try it out

The whole setup is automated using npm. Make sure you have node > 4 and npm installed.

$ git clone https://gitlab.com/paramanders/elm-twitch-chat.git
$ cd elm-twitch-chat
$ npm install

If you haven't installed Elm globally yet, make sure to do so

$ npm install -g elm

And install this project's Elm dependencies using elm-github-install. This is needed, because elm-jsonp is downloaded that exposes Native modules, which can't be downloaded from the package server.

$ ./node_modules/.bin/elm-github-install

Serve locally

You can serve the application locally using Webpack. But first, you are required to enter your username, oauth token and the channel you want to connect to into your .env file. Just copy the example, and fill in your credentials:

cp .env.example .env

To get an oauth token, you can use https://twitchapps.com/tmi.

After inserting your username, oauth token and channel, run the command to serve the application on localhost:8000:

$ npm start

and it should look like this:

Preview