Apply a gradient mask to the overlay as a whole
Angle
deg
Gradient runs from
%%

Background

Background color
Color fades into the chatter's own color
Fading amount
%

Highlighted glow color
Glow radius
px

Outlines

Enable outlines around messages
Color
Color fades into the chatter's own color
Fading amount
%

Size
px
Style

General

Use 3D translation functions to force hardware acceleration for animations

In Animations

Enable animations for messages coming in

Duration
seconds
Origin point
Timing function

Timing functions (Bézier curve only) are from Easing Functions Cheat Sheet

(The first field is the starting point of the animation, and the last field is the ending point. These will fill from the beginning point to the end point and remain at the end point until the "out" animation triggers.)


Opacity
%%
Blur amount
pxpx

Transform
X: vwvw
Y: vhvh
Scaling
X: %%
Y: %%
Skew
X: degdeg
Y: degdeg
Rotation
degdeg

Brightness
%%
Contrast
%%

Hue shift
degdeg
Saturation
%%

Out Animations

Enable animations for decaying messages

Duration
seconds
Origin point
Timing function

Timing functions (Bézier curve only) are from Easing Functions Cheat Sheet

(The first field is the starting point of the animation, and the last field is the ending point. These will fill from the beginning point to the end point, and the element will be removed once the end point is reached.)


Opacity
%%
Blur amount
pxpx

Transform
X: vwvw
Y: vhvh
Scaling
X: %%
Y: %%
Skew
X: degdeg
Y: degdeg
Rotation
degdeg

Brightness
%%
Contrast
%%

Hue shift
degdeg
Saturation
%%

History

Start effects after
message blocks

Fade out chat history
Fade out per block
%

Blur chat history
Blur amount per block
px

Scale chat history
Scaling amount per block
%
Origin point

Filters

Draw shadows underneath overlay content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath overlay content
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Overlay Management

Allow moderators to refresh the overlays
Allow Parrot to refresh the overlays

Don't render new chat messages

Images

Use lower quality images (when available)

Cleanliness

Messages decay after
seconds
System messages decay after
seconds
Limit rendered message blocks
blocks

Delay showing messages
seconds

Commands

Show metadata for Beat Saber map requests

bsr will be automatically disabled if your stream category is not set to Beat Saber when the chat overlay loads.

Debug

Allow console output
Log raw Twitch IRC messages to the DevTools console

Send a constant stream of sample messages
Message interval
seconds

User individuality settings (that are not related to flag settings) will be forcefully disabled while sample messages are active.
Enable identity flags
Maximum flags to show

Appearance

Border radius
px

Layout

Size
px
Extra spacing
px
Enable Twitch badges

Appearance

Border radius
px
Apply border radius setting to subscriber and non-role badges

Render a gradient on top of role and external badges
Colors
Angle
deg
Gradient runs from
%%
Blending mode

Enable borders around individual badges
Color
Size
px
Style

Layout

Size
px
Extra spacing
px

Display

Role badges
Game-related badges
Partner/Ambassador badges
Cheering/bits badges
Sub gifter badges
Leaderboard-related badges
Channel Founder badges
Staff badges
Moments badges
Status (no video/no audio) badges
Predictions-related badges
Prime Gaming badge
Twitch Turbo badge
Channel Subscriber badges
TwitchCon badges
Charity badges
Hype Train badges
Event-based badges

Enable broadcaster's custom Channel Subscriber badges
Enable broadcaster's custom Cheering/bits badges

Show a custom badge for affiliates
Show a custom badge for known bot accounts
Display avatars
Hide default avatars regardless of permission settings

Appearance

Size
px
Shape

Background Effect

Display avatars underneath chat message blocks

Size
px
Horizontal padding
px
Vertical padding
px

Border radius
px

Fade opacity
%%
Fade from
%% of block width
Fade angle
deg

Enable outlines around avatar backgrounds
Color
Size
px
Style

Blur amount
px

Animate background on appearance
Delay
s
Duration
s
Timing function

Permissions

Allow avatar display for:

Everyone

Moderators
VIPs
Channel artists

Channel subscribers
Twitch Turbo subscribers
Prime Gaming subscribers

Twitch affiliates
Twitch partners
Twitch staff

Active chatters
Sent messages threshold
messages

Bit cheerers
Cheer threshold

Sub gifters
Gift threshold

Clear Cached Avatars
Display pronouns
Separator

Appearance

Color
Color fades into the chatter's own color
Fading amount
%

Apply a gradient to pronouns
Gradient color
Gradient angle
deg

Font
Italic
Size
pt
Weight
Additional weight
px
Letter spacing
px
Transform

7TV

Enable 7TV integration

Enable Subscriber badges
Enable global emotes
Enable channel emotes
Enable username paints

BetterTTV

Enable BetterTTV integration

Enable Pro badges
Enable global emotes
Enable channel emotes

FrankerFaceZ

Enable FrankerFaceZ integration

Enable Subwoofer/Supporter badges
Enable global emotes
Enable channel emotes

Twitch

Manually authorizing access will open up the following data scopes:

  1. Reading cheering/bit leaderboards (bits:read)
  2. Reading advertisement scheduling data (channel:read:ads)
  3. Reading data on custom Channel Point redeems (channel:read:redemptions)

The channel you authorize with must also match the account your API keys are tied to for these scopes to be available. You cannot read this data from accounts other than your own.

App client ID
App client secret

Clear Cached Tokens
Connect to Twitch

These API keys are available in your Twitch Developer Console

Spotify

Manually authorizing access will open up the following data scopes:

  1. Reading the state of the currently active Spotify instance (user-read-playback-state)
  2. Reading the metadata of the currently playing song (user-read-currently-playing)
App client ID



Clear Cached Tokens
Connect to Spotify

External Service Tokens

Streamlabs socket token
StreamElements JWT token

OBS

Authenticate using a password
Password

TheBlackParrot's Overlay Suite

This is the settings panel for my streaming overlays, make sure this and any other part of the overlay suite is loaded in OBS!

If anything seems wrong or is malfunctioning, make sure you refresh the cache on all overlay sources (it's in the properties for each source).

Links to all public overlays and for more information on them are available at https://theblackparrot.me/overlays/

Viewers can customizer their own chat settings on the Chat Customizer page: https://theblackparrot.me/overlays/chat-customizer

If you need further/quicker support, check the Discord server invite down below!

Press this button if something is catastrophically failing

Where to find me

Bluesky
@theblackparrot.me
Discord
@theblackparrot
Discord
https://discord.gg/WFbzQ4WC8Z
Github
TheBlackParrot
Ko-fi
septilateral
Patreon
TheBlackParrot
Telegram
@theblackparrot
Twitch
theblackparrot

Status

Beat Saber Stats Overlay
inactive
Beat Saber VOD Audio System
inactive
Chat Overlay
inactive
Clock Overlay
inactive
Event List / Alerts Overlay
inactive
Goal Tracking Overlay
inactive
Heart Rate Overlay
inactive
Spotify Overlay
inactive
Twitch Clip Overlay
inactive

Beat Saber DataPuller
LiveData inactive
MapData inactive
Beat Saber Plus
inactive
HeartRateBroadcaster
inactive
OBS (Websocket v5.x)
inactive
Spotify Web API
inactive
StreamElements Socket
inactive
Streamlabs Socket
inactive
Twitch Helix API
inactive
Twitch IRC
inactive

Panel Settings

Primary color
Minimum width
px

Remote data fetching timeout
seconds

Backups

Backups to keep
backups

Restore from Backup
Delete Backup
Backup Current Settings

Backups are automatically generated every time you open OBS, and before any major overall changes take place (e.g. resetting settings to default, restoring from a backup, or importing settings).

Import / Export


Export Non-Critical Settings
Export ALL Settings
Import Settings

Enable chat emotes
Convert unicode emoji into images
Enable common third-party emotes

Border radius
px

Enlarge messages that contain only emotes
Max emotes to show
Enlarged emote size
pt
Horizontal spacing
px
Vertical block margin
px

Use newer regex pattern matching for checking if messages only contain emotes
This setting is experimental and (for me, at least) breaks chat parsing in the current version of OBS. In browsers, this will fix some unicode emoji not being set to trigger big emote mode.

Filtering

Ignore emotes that contain
(One string per line)
Ignore emotes
(One emote per line)

Cheermotes

Enable Cheermotes
Color amount text associated with the Cheermote
Use the animated versions of Cheermotes

Clear Cached Emotes

General

Mute on unflagged map hashes
Mute when returning to the menu

OBS Settings

Audio source to control
VOD-only audio track

Database

Use remote map hash databases
Remote database URLs
(One URL per line)
(Must point to a .json file)
Mute on conflicting safe/unsafe flags

OBS Bug Workaround

OBS currently has a bug causing "crackling" once audio starts coming from browser sources. If a noise is constantly sent from a browser source, this will prevent the "crackling" or "snappiness" of new sounds.

You may need to refresh the chat overlay after turning this on or off.


Play constant white noise to work around this bug with OBS's CEF
Volume
5%
Lowpass filter frequency
5hz

Chat Message Noises

Play a sound on incoming chat messages
Include system/overlay messages
Include emote-only messages

Sound
Volume
50%
Pitch
%to%
Delay
s

Custom sound URLs
(One URL per line)

External URLs must have Access-Control-Allow-Origin headers that allow this page's root domain, or everything. Many websites have cross-origin requests blocked, if your sounds do not work, try a host that allows cross-origin requests or use a host you have control over. catbox.moe is one that I'm aware of that allows cross-origin requests.

Twitch

Twitch channel to join
Channel connected to is your own Twitch account

OBS

IP address
Port

Beat Saber

Beat Saber Plus port
DataPuller port

Use data from

The settings panel will need to be reloaded after switching which data mod is being used for Beat Saber-related overlays. You can do this by right-clicking the settings panel and clicking Refresh in the menu that pops up.

HeartRateBroadcaster

IP address
Port

HeartRateBroadcaster can be downloaded from CatseTheCat's GitHub repository for the project: https://github.com/catsethecat/HeartRateBroadcaster

Layout

Use right-aligned layout
Flip vertical order of song details

Hide overlay if music is paused
Enable animations

Overlay margin
px
Element spacing
px
Line height
px

Timers

Song progress interval
seconds

Refresh interval
seconds
New song refresh delay
seconds

Marquee

Scroll the title if it extends outside the boundaries of the page/source
Delay between scroll loops
seconds
Gap between scroll loops
px
Scroll speed
px / second

Cover Art

Display album art/cover art
Container size
px
Border radius
px

Image size
px
Image quality
%

Image settings will apply when new track data is obtained

Display an outline around the album/cover art
Reflect current track progress with the outline
Outline size
px
Outline brightness
%

Background Effect

Display album/cover art underneath overlay content
Separate the background and overlay content

Add a gradient mask to the album/cover art
Mask width
%
Mask height
%
Mask range
%%

Opacity
%
Blur amount
px
Fade in duration
seconds

Title

Color
Font
Italic
Size
pt
Weight
Additional weight
px
Transform

Secondary Metadata

Show album metadata along with artist metadata
Switch every
seconds
Mention if the track an album is on is a single
Show label/publisher information after album information (* if available)
Show release year after album information

Secondary metadata color reflects album art/cover art color
Use darker album art/cover art color
Default color

Ensure secondary color is between a set brightness level
Minimum
%
Maximum
%

Font
Italic
Size
pt
Weight
Additional weight
px
Transform

Apply a gradient to the secondary metadata display
Gradient color
Gradient angle
deg

* Label/publisher information is fetched from MusicBrainz using the song's ISRC, as Spotify does not provide this information in a public API call.

Scannables

Display a scannable code linking directly to the currently playing track

Height
px
Border radius
px

Use lighter album art color for the background color
Use black foreground color
Automatically determine foreground color
Invert threshold
%
(0% is equivalent to full black, 100% is equivalent to full white)

Force a custom background color
Background color

Apply a gradient to scannables
Colors
Angle
deg
Gradient runs from
%%
Blending mode
Enable outlines around scannables
Color
Size
px
Style

Filters

Draw shadows underneath text content
Draw shadows underneath scannable's foreground content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath text content
Draw outlines underneath scannable's foreground content
Scannable's outline color reflects its background color
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Draw box shadows underneath image content
Color
X offset
px
Y offset
px
Blur amount
px
Blur inset amount
px

Display

Show local/system time
Show stream uptime
Show time to next ad break

Use 12-hour time format
Pad leading value with a leading zero
Hide the hour on timers if the time doesn't exceed 60 minutes

Layout

Fade between each enabled clock
Switch every
seconds
Fade duration
seconds

Line spacing
px
Element width
px

Horizontal margin
px
Vertical margin
px

Horizontal alignment

Headers

Local clock header
Stream uptime header
Ad timer header

Use %zn for the full timezone name, %zi for initials, and %zo for the offset relative to GMT.

Color
Reflect the Now Playing overlay primary color

Font
Italic
Size
pt
Weight
Additional weight
px
Character spacing
px
Transform

Clock

Color
Reflect the Now Playing overlay primary color

Main font
Italic
Seconds font
Italic
Meridiem font
Italic

Main size
pt
Seconds size
pt
Meridiem size
pt

Main weight
Seconds weight
Meridiem weight

Main extra weight
px
Seconds extra weight
px
Meridiem extra weight
px

Character spacing
px
Seconds character spacing
px
Meridiem character spacing
px

Filters

Draw shadows underneath overlay content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath overlay content
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Filters

Draw shadows underneath text content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath text content
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Draw box shadows underneath image content
Color
X offset
px
Y offset
px
Blur amount
px
Blur inset amount
px

Effects

Desaturate the overlay when paused
Desaturate amount
%
Pause fade transition
s
Resume fade transition
s

Layout

Hide overlay if not playing a map

Height
px
Horizontal margin
px
Vertical margin
px

Element order
Available elements: acc, art, hitmiss, metadata, misc
Element spacing
px

Accuracy Cell

Width
px
Line height
px

Flip vertical order of accuracy / combo
Horizontal alignment

Animate accuracy changes
Interval
ms

Accuracy color
Accuracy font
Italic
Accuracy size
pt
Accuracy font weight
Additional accuracy weight
px
Accuracy character spacing
px

Combo color
Combo font
Italic
Combo size
pt
Combo font weight
Additional font weight
px

Cover Art Cell

Use cover art from BeatSaver instead of the in-game texture

Size
px
Border radius
px

Display an outline around the album/cover art
Reflect current track progress with the outline
Outline size
px
Outline brightness
%

Background Effect

Display album/cover art underneath overlay content
Separate the background and overlay content

Add a gradient mask to the album/cover art
Mask width
%
Mask height
%
Mask range
%%

Opacity
%
Blur amount
px
Fade in duration
seconds

Hit / Miss Cell

Width
px
Line height
px

Flip vertical order of hit / miss stats
Horizontal alignment

Color
Font
Italic
Font size
pt
Font weight
Additional font weight
px

Full combo icon color
Hit icon color
Miss icon color

Miscellaneous Info Cell

Width
px
Line height
px

Flip vertical order of miscellaneous information
Horizontal alignment

Primary font color
Font
Italic
Font weight
Difficulty font size
pt
Time font size
pt

Easy difficulty
Color

Normal difficulty
Color

Hard difficulty
Color

Expert difficulty
Color

Expert+ difficulty
Color

Alignment

Flip vertical order of song details
Horizontal alignment
Line height
px

Title

Color
Font
Italic
Font size
pt
Font weight
Additional font weight
px
Transform

Scroll the title if it extends outside the boundaries of the page/source
Delay between scroll loops
seconds
Gap between scroll loops
px
Scroll speed
px / second

Secondary Metadata

Secondary metadata color reflects album art/cover art color
Use darker album art/cover art color
Default color

Ensure secondary color is between a set brightness level
Minimum
%
Maximum
%

Show mapper metadata along with artist metadata
Switch every
seconds
Use BeatSaver's provided mapper and collaborator data rather than mapper data stored internally
Maximum collaborators
users

Font
Italic
Font size
pt
Font weight
Additional font weight
px
Transform

Apply a gradient to the secondary metadata values
Gradient color
Gradient angle
deg

Streamer

Color
Font
Italic
Font size
pt
Font weight
Additional font weight
px

Apply a gradient to the streamer's name
Gradient color
Gradient angle
deg

Show the streamer's avatar underneath text content
Blur amount
px

Video

Video border radius
px

Enable borders around clip content
Color
Size
px
Style

Details

Title color
Title font
Italic
Font size
pt
Font weight
Additional font weight
px

Apply a gradient to the clip title
Gradient color
Gradient angle
deg

Details color
Details font
Italic
Font size
pt
Font weight

Show the game's cover art underneath text content
Blur amount
px
Only fetch streamer's featured clips
Select a random clip, use the most popular clip otherwise

Allow streamers raiding in to play one clip on their own

Trigger command

Clip Selection

Limit clip duration between
andseconds
Amount of clips to fetch
clips
Twitch forces sorting by view count on clips, so only the clips with the highest amount of views will be selected.

Preferred video quality
Overlay margin
px
Element spacing
px

Video

Height
px

Video width will be forced to a 16:9 resolution, the width is determined from the height.

Details

Show clip details
Horizontal alignment

Animations

Enable animations

Filters

Draw shadows underneath text content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath text content
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Draw box shadows underneath video container
Color
X offset
px
Y offset
px
Blur amount
px
Blur inset amount
px
Force the overlay to a set width
Width
px

Reverse the order of messages within message blocks

Corner alignment
Alternate the horizontal corner alignment
Content width

Vertical margin
px
Horizontal margin
px

Vert. block padding
px
Horiz. block padding
px
Block spacing
px
Border radius
px
Background color
Color fades into the chatter's own color
Fading amount
%

Vertical padding
px
Horizontal padding
px
Bottom margin
px
Border radius
px
Element spacing
px

Vertical offset
px
Horizontal offset
px

Enable outlines around chatter information
Outline color
Color fades into the chatter's own color
Fading amount
%

Size
px
Style

Names

Ensure name colors are between a set brightness level
Minimum
%
Maximum
%

Force names to use the default name color
Default color

Use the prominent color of the chatter's avatar over default name colors
Use the prominent color of the chatter's avatar as a fallback for not setting a color

Apply a gradient to names
Gradient color
Gradient angle
deg

Font
Italic
Size
pt
Weight
Additional weight
px
Letter spacing
px
Transform

International Names

Margin
px
Size scaling
%
Weight scaling
%
Saturation
%
Allow inline Markdown formatting

Background color
Color fades into the chatter's own color
Fading amount
%

Text color
Color fades into the chatter's own color
Fading amount
%

Colors for mentions reflect the chatter being mentioned
Fade mention color into another color
Fading color
Fading amount
%

Font
Italic
Size
pt
Weight
Letter spacing
px
Transform
Emboldening amount
px
Line height
px

Vertical offset
px
Horizontal offset
px
Vertical padding
px
Horizontal padding
px
Border radius
px

Enable outlines around chat message blocks
Outline color
Color fades into the chatter's own color
Fading amount
%

Size
px
Style

Enable separators between messages
Color
Width
px
Spacing
px
Style

Event Tags

Tag messages with subscription notices
Resub format
New sub format

Tag messages with cheer notices
Cheer format

Tag messages with channel point redemptions
Redemption format

Tag messages with watch streak notices
Notice format

Tag announcement messages
Tag string

Tag messages from first time chatters
Highlight messages from first time chatters
Tag string

Use %amount in fields with varying amounts to show the amount of said event
Use %tier in subscription/resubscription fields to show the subscription plan name
Use %name in the point redemption field to show the name of the redemption
Use %reward to show the channel point reward if points are being given to the viewer

Prime plan name
Tier 1 plan name
Tier 2 plan name
Tier 3 plan name

Color
Font
Italic
Size
pt
Weight
Additional weight
px
Letter spacing
px
Transform
Line height
px

Timestamps

Add timestamps before message text
Hide timestamps if message only contains emotes
Track stream uptime rather than current local time
Format

Local time formatting available: here
Duration time formatting available: here

Color
Apply a gradient to timestamps
Gradient color
Gradient angle
deg

Font
Italic
Size
pt
Weight
Additional weight
px
Letter spacing
px

Horizontal margin
px
Hide messages attached to custom channel point redemptions

Hide messages from viewers until enough messages have been sent
Message count threshold
messages
This setting will not apply to VIPs and moderators.

Hide messages suspected of being copypasta ASCII art
ASCII art content percentage
%

Hide accounts
(One account per line)

Censor words in chat
(One word per line, harsher filter)
Censor words in chat
(One word per line, softer filter)

The harsher filter combines chat messages into one long string of characters with non-letter characters stripped out, and characters with accent marks are "devolved" back to an English alphabet.
The softer filter specifically only looks for the word given, it does not combine the message into one long string of characters. Put words here if you get false positives. (This will also include words given for the harsher filter).

Hide messages associated with custom chat commands
Command character

Bots

Automatically hide known bot accounts

Users to add to the list
(One account per line)
Users to remove from the list
(One account per line)

Known bot list data is fetched from Twitch Insights
Allow chatters to customize personal settings

Allow chatters to change the shape of their avatars

Allow chatters to change their name colors
Allow chatters to change their name font (and related settings)
Allow chatters to add an extra glow/shadow to their name
Allow chatters to add transform functions to their name

Allow chatters to change their message font (and related settings)

Viewers can customize their own personal settings on the Chat Customizer page: https://theblackparrot.me/overlays/chat-customizer
Timeout after
seconds

Peak Display

Icon color
Icons reflect the Now Playing overlay primary color

Apply a gradient to icons
Gradient color
Gradient angle
deg

Color
Font
Italic
Size
pt
Weight
Additional weight
px
Character spacing
px

Value Display

Icon size
em
Icon color
Icon reflects the Now Playing overlay primary color

Apply a gradient to icons
Gradient color
Gradient angle
deg

Color
Font
Italic
Size
pt
Weight
Additional weight
px
Character spacing
px

Animations

Pulse the heart icon at the speed of the current heart rate
Pulse strength
%

Animate heart rate value changes
Interval
ms

Filters

Draw shadows underneath overlay content
Color
X offset
px
Y offset
px
Blur amount
px

Draw outlines underneath overlay content
Color
Matrix Size
Divisor

Smooth out corners of the outline matrix
Distance threshold

Display

Show peak heart rate
Show peak heart rate for individual Beat Saber maps while playing a map

Pad heart rate with leading zeros
Fade out leading zeros

Layout

Line spacing
px
Element width
px

Horizontal margin
px
Vertical margin
px

Horizontal alignment
This tab may contain sensitive information and/or content; it is not advised to have this information publicly visible.

Click the button below to reveal this tab.
Reveal Tab
Back