- twitchat.fr -

A custom Twitch chat that aims to fill gaps in the official Twitch chat for streamers.
The main goal is to allow a streamer to follow his chat as best as possible.

For developers, Twitchat exposes an API to receive events and control some features remotely.
Documentation can be found here.

Features

• Create your own sub/follow/rewards/poll/... alerts with the OBS trigger system that allows to control your OBS sources and filters when an event occurs
• Display the first message of users seperatly so you don’t forget to greet them
• Make it easier to follow a conversation between users
• Remember where you stopped reading the chat by clicking any message
• Track a user to make sure not to miss her/his messages
• Create a raffle with the viewers and pick random winners
• Create a bingo in which users have to find a number or an emoji
• See if a user is not following the channel
• Display received whispers and answer them
• Filter some messages (bots, commands, self, /me, etc...)
• Customize messages (remove badges, show minimalist badges, remove emotes)
• Customize messages appearance by roles (viewers, mods, vips, subs)
• Moderate messages (ban, timeout, delete message)
• Allow/deny messages blocked by AutoMod
• Display when it’s the first message ever of a user on the channel
• Display mod notifications on chat (i.e. “User XXX has been banned by YYY”)
• Display sub/bits/raid/reward/follow notifications
• Display hype train status
• Show the informations about the last stream of a raider
• Embedded activity feed to see subs/cheers/follows/raids/rewards history
• Create/delete polls
• Create/delete predictions
• Emote selector
• BTTV and FFZ emotes supported
• Message autocomplete nickname via “@”, emotes via “:”, commands via “/” or all via TAB key
• Allow to search on all messages via command /search
• Split view in half with chat on left and notifications/activity feed, new viewers, etc.. on the right
• Filter out only specific commands
• See live viewer count
• Keep or remove deleted messages
• See all my followings that are live to raid them easily
• Supports new boost trains
• Supports new /announce message feature
• Allow your mods to control your OBS scenes or mute/unmute your mic from chat
• Expose an API to control some stuff remotely
• Stream Deck plugin
• Chat poll feature: kind of a poll where your viewers decide its options

• Request scopes on-demand
• Handle new “low trust” feature (Done but no available scope to actually receive the messages).

Project setup

First, create a credentials.json file on the root directory and fill in these values:

{
	"client_id": "",
	"client_secret": "",
	"redirect_uri": "http://localhost:8080/oauth",
	"csrf_key": "",
	"scopes": [
		"chat:read",
		"chat:edit",
		"channel:read:redemptions",
		"channel:moderate",
		"moderation:read",
		"moderator:manage:automod",
		"channel:manage:polls",
		"channel:manage:predictions",
		"channel:read:hype_train",
		"channel_editor",
		"whispers:edit",
		"user:read:follows",
		"channel:edit:commercial",
		"channel:read:subscriptions"
	]
}

Create a Twitch application and fill in the client_id and client_secret values.
Write anything in the csrf_key field, it will be used to secure twitch authentication from CSRF attacks.
Configure the redirect URI of the Twitch application with your localhost and/or production URI.
Set it as the redirect_uri value of the credentials.
The redirect uri must end with /oauth, example:

http://localhost:8080/oauth

By default the server listens on port 3018, you can change it on `server.js` and `src/utils/Config.ts`.

Compile project

Install dependencies

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run server

node server.js

Install server

Compile the project and push the server.js file on your server.
Next to this file, create a dist folder and push the content of your local dist folder inside it.
Also add the credentials.json and fakeEvents.json files at the root of the project.
Create an env.conf file, just write prod inside, and push it at the root of the project.
Install all the production dependencies and run the server.
Here is the expected file structure:
─ root
├─ dist/
├─ node_modules/
├─ server.js
├─ env.conf
├─ credentials.json
├─ fakeEvents.json

Server

The server is super basic for now as there aren’t much needs. For this reason, it’s a just a single file server coded in vanilla JS that doesn’t need any compilation. That might change in the future.