Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paramander/elm-twitch-chat
Elm powered Twitch chat using WebSockets
https://github.com/paramander/elm-twitch-chat
elm twitch websockets
Last synced: 8 days ago
JSON representation
Elm powered Twitch chat using WebSockets
- Host: GitHub
- URL: https://github.com/paramander/elm-twitch-chat
- Owner: paramander
- License: mit
- Created: 2016-08-20T20:09:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-26T16:12:59.000Z (over 6 years ago)
- Last Synced: 2024-03-06T19:33:40.772Z (4 months ago)
- Topics: elm, twitch, websockets
- Language: Elm
- Size: 64.5 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-twitch-dev - paramander/elm-twitch-chat - Elm powered Twitch chat using WebSockets. (Libraries / Elm)
README
# 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
- [x] Receiving messages
- [x] Sending messages
- [x] Emotes
- [x] Subscriber badges
- [x] Turbo badges
- [x] Mod badges
- [x] Global mod badges
- [x] Admin badges
- [x] Staff badges
- [x] Broadcaster badges
- [x] Bits badges (wrong implementation, will have to use the new [badges.twitch.tv](https://badges.twitch.tv) endpoint)
- [ ] Cheers
- [x] Resubscribe notices
- [x] Subscribe notices
- [ ] Timeout/ban actions
- [x] `/me` actions
- [ ] Emote picker
- [ ] Viewer list
- [x] `@` 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](https://twitchapps.com/tmi).
After inserting your username, oauth token and channel, run the command to serve
the application on [localhost:8000](http://localhost:8000):
```
$ npm start
```
and it should look like this:
