A custom twitch chat that aims to fill gaps in the official Twitch chat for streamers.
The main goal is to follow your chat as best as possible.

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

Features

Project setup

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

{
	"admin_ids": ["YOUR_TWITCH_ID"],
	"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",
		"user:read:blocked_users",
		"user:manage:blocked_users",
		"moderator:manage:banned_users",
		"moderator:manage:announcements"
	],
	"spotify_client_id": "",
	"spotify_client_secret": "",
	"spotify_scopes": "user-read-currently-playing user-modify-playback-state playlist-read-private",
	"spotify_redirect_uri": "http://localhost:8080/spotify/auth"
}

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

You can also create a spotify application and fill in the spotify spotify_client_id and spotify_client_secret
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 dev

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 isn't much needs. For this reason it's a just a single file server coded in vanila JS that doesn't need any compilation. That might change in the futur.

Package Stream Deck™ plugin

Delete the following file:

streamdeck_plugin/fr.twitchat.streamDeckPlugin

Run the following command:

npm run streamdeck_package

The file fr.twitchat.streamDeckPlugin should be built back.

TODO

Make a MASSIVE refactoring to abstract twitch's data model throughout the codebase to make other services (youtube, tiktok, ...) easier to add to twitchat.
Review the filtering logic of the messages so they're not the ones responsible to decide their own visibility
rebuild server with typescript

rachids/Twitchat