- twitchat.fr -
- Join discord -

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

• Enable an emergency button with custom actions to prevent from follow bots and doxxing
• Create your own sub/follow/rewards/poll/... alerts and chat commands with the Trigger system that allows to control your OBS sources and filters as well as Spotify or Deezer when an event occurs
• Display the first message of users seperatly so you don't forget to greet them
• Send any message from your chat to your stream with a single click
• 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 and pick random winners. An overlay is available to display a wheel that selects a winner.
• Create a bingo in which users have to find a number or an emoji
• Ask your viewers for suggestions with a dedicated command
• 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 (ex: "User XXX has been banned by YYY")
• Display sub/bits/raid/reward/follow notifications
• Display hype train status
• Show the last stream info of a raider
• Integrated activity feed to see subs/cheers/follows/raids/rewards history
• Create/Delete polls
• Create/Delete predictions
• Emote selector
• BTTV, FFZ and 7TV 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 viewers 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
• Handles "low trust" feature (more info)
• Custom spoiler feature so viewers can hide message contents to the streamer
• Alert command to make Twitchat shake, blink, emit sound and display a message over everything else
• Edit your stream's info from Twitchat with possibility to create pressets
• Create a timer or a countdown with a simple command and show it on your stream
• Control spotify or deezer from chat commands (create your own song request system) and show currently playing track on your stream
• And many other things....

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",
		"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",
	"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.

npm install

npm run dev

npm run build

node server.js

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

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.