Overlay widgets
Every widget in the Overlay library, its ID and its main settings
Every widget in the Overlay tab's library, grouped the way the library groups them, with the ID its URL uses and the settings that shape it.
Settings every widget has
Most widgets open on the same sections, in this order: Content, the widget's own sections, Text, Appearance, Shadow & depth, Animation and Position & size, with a live Preview. The tables below list what each widget adds. Every widget except Alerts can have copies, each with its own settings and URL. See Overlay URLs for how to address a copy.
Look controls every widget shares
| Section | Settings |
|---|---|
| Shadow & depth | Drop shadow; a round dial for its direction and distance (Shift snaps to 15°, double-click resets); Quick shadows (Soft, Hard, Glow, Long, Inner); Softness, Spread, Shadow strength, Shadow color, Inside the edge; under Whole widget, Widget opacity, Tilt and Scale; Reset shadow & depth |
| Text | Text weight, Alignment, Letter spacing, Line height, Letter case, Italic, Readability effect (Shadow, Outline or Glow; a shadow has its own Direction) |
| Appearance | Corner radius, Border width, Border color, Border style (Solid, Dashed, Dotted or Double) |
| Animation | Animation style, Exit style (or Same as entry), Motion feel, Animation length, Replay |
| Position & size | Left (%), Top (%), Width (%), Height (%), Snap to, Fill canvas |
Scale runs from 0.25 to 3 times the widget's size and Tilt from -180° to 180°. Where a widget casts its shadow from its own shapes, such as the particle widgets, Viewer Buddies and the gift jar, Spread, Inside the edge and Inner are left out. The particle widgets and Viewer Buddies have no Animation section.
The preview's stage shows the widget's box where it sits on the canvas: drag it to move it, drag a handle to resize it, and hold Alt to stop it snapping. Canvas shape switches between Landscape 16:9 and Vertical 9:16 (TikTok LIVE).
In each widget's settings, Style opens the style tools: Copy style, Paste style, Save as preset…, My styles and Starter styles (Clean dark card, Neon glow, Soft light card, Bold outline, Glass and Sticker). A style is the widget's colors, text, border and corners, shadow and depth, and animation, and a paste copies only the parts both widgets have. You can save up to 50 styles.
Chat
| Widget | ID | Main settings |
|---|---|---|
| Chat Box | chat | Max messages, Fade out after (s, 0 = never), Hide ! and / commands, Ignored viewers, Show avatars, Show platform badge, Name color, Message color, Bubble color, Bubble opacity, Bubble image; under Layout, Message style (Bubble, Inline or Stacked), New messages at, Message width, Avatar size, Avatar shape and Emote and emoji size; Highlights for chosen Words or Viewers |
Simulate chat sends sample messages to the preview.
Alerts
| Widget | ID | Main settings |
|---|---|---|
| Alerts | alerts | Alert delay (seconds), Alert duration (s), Min. gift diamonds (0 = all), Like milestone every, Master volume, Play alert sounds in, Show gift image, Show card background, Show platform badge |
Each alert type (gift, follow, share, like, subscription and raid) has its own Custom message, Alert sound, Images and videos, More sounds (random), Duration (s, 0 = global) and colors. Alert delay (seconds) goes up to 60. Alerts covers variations and sounds per gift.
Feeds
| Widget | ID |
|---|---|
| Gift Feed | giftFeed |
| Diamond Ticker | diamondTicker |
| Last Gifter | lastGifter |
| Last Follower | lastFollower |
| Last Liker | lastLiker |
| Last Sharer | lastSharer |
| Last Comment | lastChatter |
| Last Subscriber | lastSubscriber |
| Last Viewer In | lastJoiner |
Main settings: Shows (A rolling list or Who did it last), Event, Entries shown, Minimum diamonds, New entries appear (At the top, At the bottom or As a ticker), Show avatars, Title and Row spacing.
Counters
| Widget | ID |
|---|---|
| Viewer Count | viewerCount |
| Follower Count | followerCount |
| Stream Clock | streamClock |
| Gift Counter 1–3 | giftCounter1 to giftCounter3 |
| Stat Label 1–3 | statLabel1 to statLabel3 |
| Clock and Countdown | clock |
Main settings, except for Clock and Countdown: Source (Live metric or Stream uptime), Metric, Platform (one platform or All platforms), Counting from (This stream or All time), Label, Prefix, Suffix, Number format and Stack label above value.
Clock and Countdown
New in Alpha 0.4.0. It shows the time of day, the date, a countdown or a count up, and starts switched off. It is a plain clock: gifts never add time to it. For a subathon clock, use the Countdown Timer under Goals. Stream Clock, above, shows how long you have been live.
| Shows | What it does |
|---|---|
| Time | The time now. Leave Time zone empty for this PC's time, or type a zone such as Asia/Tokyo |
| Date | Today's date, in the Date style you pick |
| Countdown | Counts down to the date and time in Counts down to. In 5 min, In 15 min, In 30 min and In 1 h set it in one click. At zero, show replaces 0:00 with your text, such as "Starting now!" |
| Count up | Counts up from the moment in Counts up from, or from Start from now |
Under Format: Hours (Auto, 12-hour or 24-hour), Show seconds, Show the time zone, Show the date under the time, Date style, and Reads as for a countdown or count up, as a clock (1:02:03) or in units (1h 2m 3s). Under Label: Label and Label sits (Above, Below, Before or After), in the Label color.
A countdown or count up is saved as a moment in time, so it keeps counting through an OBS reload or a restart of Vfinity. The clock has no commands.
Goals
| Widget | ID | Main settings |
|---|---|---|
| Goal 1–4 | goal1 to goal4 | Mode (Progress bar or Race the clock), Metric, Target, Time limit (seconds), Target grows by, When reached (Stay complete or Start the next goal), Text when reached, Add by hand, Reset progress |
| Countdown Timer | timer | Starting time, Count (Down to zero or Up from zero), Clock format, Title position, Seconds per coin, Per-gift time, Time from other events, Gifts restart a finished timer, Finished text, Urgency under (seconds, 0 = off), Progress bar, Show added time (+30s) |
| Coin Jar | coinJar | Shape (Bar, Circle or Jar), Metric, Full at, Counts down instead of up, Show the top viewer avatar, Start the next goal automatically, Target grows by |
| Stream Boss | streamBoss | The same settings as Coin Jar |
Time from other events gives the timer Seconds per follow, Seconds per share, Seconds per subscription, Seconds per Super Fan, Likes per step and Seconds per like step. Count each viewer once counts a viewer's follow once per stream.
Leaderboards
| Widget | ID |
|---|---|
| Top Gifters | topGifter |
| Top Liker | topLiker |
| Gifter Streaker | topStreaker |
| Top Chatters | topChatter |
| Points Ranking | pointsRanking |
| Credits | credits |
Main settings: Rank by, Ranking from (Vfinity's count or TikTok's top viewers), Counting from, Places shown, Layout (Ranked list or Rolling credits), Seconds per pass, Gold, silver and bronze top three, Hide these viewers, Show avatars and Show platform badge.
Effects
| Widget | ID |
|---|---|
| Gift Cannon | giftCannon |
| Like Fountain | likeFountain |
| Gift Firework | giftFirework |
| Falling Snow | fallingSnow |
| Emojify | emojify |
| Emote Wall | emoteWall |
| Confetti | confetti |
Main settings: Set off by (an event, or Always running), Minimum diamonds, Particles show (The sender's avatar, The gift artwork, A custom image or A plain shape), Particles per burst, Particle size, Speed, Gravity, Time on screen and Particle limit.
Presentation
| Widget | ID | Main settings |
|---|---|---|
| Events Board | events | Display style (List, Grid, Scrolling or Slideshow), Seconds per item, Scroll direction, Events |
| Text | staticText | The media settings below |
| Image | staticImage | The media settings below |
| Video Player | videoPlayer | The media settings below |
| Social Rotator | socialRotator | The media settings below |
| Sponsor Banner | sponsorBanner | The media settings below |
| Webcam Frame | webcamFrame | Style, Thickness, Corner rounding, Frame color, Glow, Corner accents, See through the middle |
| Scene Frame | overlayFrame | The same settings as Webcam Frame |
| Talking Banner | talkingBanner | The same settings as Webcam Frame |
| Actions media | actionMedia | Maximum on screen, Mute all videos |
| Custom Widget | customWidget | Your code, Send live stats to your code |
| Scene Card | sceneCard | See Scene Card below |
| Checklist | checklist | See Checklist below |
Text, Image, Video Player, Social Rotator and Sponsor Banner share one set of media settings. Shows picks Text, An image, A video or Rotating slides; the rest follow from it: Image fit, Video URL, Loop, Muted, Seconds per slide and Caption sits. Actions media shows what Show an image or video steps send.
Scene Card
New in Alpha 0.4.0. One card for the screens around your stream: Starting soon, Be right back and Stream ending. It starts switched off.
| Setting | What it does |
|---|---|
| On screen | Three tiles pick the scene viewers see |
| Starting soon: title, Be right back: title, Stream ending: title | Each scene's title, with a subtitle under it. Left empty, the titles read "Starting soon", "Be right back" and "Thanks for watching!" |
| Social handles | One line, such as @you · youtube.com/@you |
| Layout | Full screen, Card or Lower third |
| Countdown | Start (then Restart), Stop, Add a minute and Take a minute off; Minutes (1–240, 5 to start); At zero, show replaces the countdown with your text, or leave it empty to take the countdown away |
| Rotating messages | Up to 12 lines that take turns under the title, Seconds each (3–120) and Changes with (Fade or Slide) |
| Background | Color or Picture; a picture gets a Tint color and Tint strength |
The countdown is saved as the moment it ends, so it keeps counting through an OBS reload or a restart of Vfinity.
| Command | What it does |
|---|---|
sceneCard.showStarting, sceneCard.showBrb, sceneCard.showEnding | Puts that scene on screen and switches the card on |
sceneCard.hide | Switches the card off |
sceneCard.countdownStart, sceneCard.countdownStop | Starts or stops the countdown |
Each command acts on the card and on every copy of it. All but
sceneCard.hide are also in the card's right-click menu.
Checklist
New in Alpha 0.4.0. A list you tick off live, such as your goals for the stream. It starts switched off.
| Setting | What it does |
|---|---|
| Items | Type in New item and press Enter to add one, up to 30. Tick an item to check it off on stream, drag its grip to reorder, or delete it and Undo. Check the next one and Uncheck all work on the whole list |
| Show a title, Title | The heading, "Stream goals" when left empty |
| Show the count (3/5), Show a progress bar | How far through the list you are |
| Checked items | Cross out, Fade or Hide |
| Mark | Box, Circle, Tick or Number |
| Items on screen | 1–30. A longer list scrolls to keep the first open item in view |
| Flash an item as it is checked | A short highlight when you tick one |
| Command | What it does |
|---|---|
checklist.checkNext | Checks the next open item |
checklist.uncheckAll | Unchecks every item |
The commands also reach any copy showing the same list, and they are in the card's right-click menu.
Interaction
| Widget | ID | Main settings |
|---|---|---|
| Physics gift jar | giftJar | Empty gift jar |
| Wheel of fortune | wheel | Options with a Weight each, Chat command (!spin), Spin cooldown (seconds), Minimum gift diamonds (0: no gift spins) |
| Chat poll | poll | Options, Chat command (!vote), Start new poll, Close poll |
| Viewer queue | viewerQueue | Chat command (!join), Maximum entries, Next viewer, Open / close queue |
| Giveaway draw | giveaway | Chat command (!enter), Who can enter, Maximum entries, Most tickets per viewer, Gift value for a bonus (diamonds), Bonus tickets per gift (0: off), No repeat winners |
| Tug of war | tugOfWar | Each team's name, color, Chat vote (!red, !blue) and Gifts that pull for this team; Points per chat vote, Points per diamond, Points per like (0: off), Winning score (0: none), Round length in seconds (0: no clock), Start the next round after (seconds, 0: off) |
| Hype meter | hypeMeter | What adds hype, Drain per second, Levels with a name, color and points each, Direction |
| Viewer Buddies | viewerBuddies | Most buddies at once, Leave after being quiet for, Buddy size, Walking speed, Name tags, Speech bubbles for chat, Hearts float up on likes, Font |
The wheel waits at least 4 seconds between spins. The hype meter's five levels start as Warm, Hot, On fire, Inferno and LEGENDARY. Viewer Buddies can also bring a buddy on a join, a follow or subscription, and a gift; Test: spawn a buddy sends one to OBS.
The game widgets' commands are listed under Games, and their results fire the game triggers in Triggers.