Usage

URL: https://kaedenn.github.io/twitch-filtered-chat/index.html?<OPTIONS>

Options:

Option Key	Option Value
layout	Layout to use, explained below
config_key	Config key override (default: "config")
clientid	ClientID override to use for Twitch asset loading
user	Username to use (requires "pass" too)
pass	OAuth token to use (requires "user"; removed once parsed)
debug	One of "true", "false", "debug", "trace" (default: "false")
channels	Channels to join (without #), separated by commas
noassets	Prevents loading of image (badge, emote, cheer) assets
noffz	Disable FFZ support entirely
nobttv	Disable BTTV support entirely
hmax	Maximum number of chat messages to retain (default 300)
trans	Makes the backgrounds completely transparent
module1	The encoded module configuration for the first module, explained below
module2	The encoded module configuration for the second module, explained below
reconnect	If present, automatically reconnect if connection is lost

Layout:

layout=<columns>[:<chat>]

columns: one of single, double

chat: at most one of chat, nochat, slim

layout=double:chat is the default

Module configuration:

module1=<name>,<flags>,<kw-include>,<user-include>,<user-exclude>,<start-exclude>,<channel-exclude>

module2=<name>,<flags>,<kw-include>,<user-include>,<user-exclude>,<start-exclude>,<channel-exclude>

If layout is single, module1 is shown. Otherwise, module1 is the left module and module2 the right.

name: Module's name

flags: a sequence of 1s (shown) or 0s (filtered) for Pleb, Sub, VIP, Mod, Events, and Bits

kw-include: Display the message if it contains the value given, overriding excludes

user-include: Always show messages from this user, overriding

user-exclude: Don't show messages from this user

start-exclude: Don't show messages starting with the value given

channel-exclude: Exclude messages from this channel (for layout=double usage)

Default: module1=Chat,111111,,,,,&module2=Chat,111111,,,,,

Examples:

Connect to #dwangoAC with default configuration:

?channels=dwangoAC

Connect to #pangaeapanga with no chat:

?channels=pangaeapanga&layout=double:nochat

Connect to #dwangoAC in slim mode, filtering TAS9000 and messages starting with !:

?channels=dwangoac&module1=Chat,111111,,,TAS9000,!,&layout=single:slim

Development

For getting started, you will need both this and twitch-api:

mkdir tfc && cd tfc # optional
checkout https://github.com/Kaedenn/twitch-filtered-chat
checkout https://github.com/Kaedenn/twitch-api
cd twitch-filtered-chat

and have fun!

Credits

YoshiRulz - Improving rainbow effect

Inverted - Improving username contrast