Overlay URLs
The local server, its hash routes, and the query parameters each source page reads.
Vfinity runs an HTTP and WebSocket server on your own machine. OBS loads each widget from it as a browser source.
The base
http://127.0.0.1:21424/#<route>Port 21424 is the default. If something else holds it when Vfinity starts, Vfinity picks another port and says so, and the Dashboard shows the URL that is actually live. Copy the URL from the app rather than typing it.
You can set a preferred port in SettingsConnections on the Throw Item Overlay card. It takes effect after a restart.
Widget
Instance
Language
Browser source URL
http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=enNot thishttp://127.0.0.1:21424/#overlay-goal?id=goal1?lang=enA second ? makes the id parse as part of itself and the widget renders empty.
Routes
| Route | Widget |
|---|---|
#throwing | The throwing scene |
#overlay-chat | Chat Box |
#overlay-alerts | Alerts |
#overlay-events | Events Board |
#overlay-timer | Countdown Timer |
#overlay-stat?id= | Counters and stat labels |
#overlay-leaderboard?id= | Leaderboards |
#overlay-goal?id= | Goals |
#overlay-feed?id= | Feeds and "last X" cards |
#overlay-particles?id= | Effects |
#overlay-media?id= | Text, image, video, rotators, banners |
#overlay-frame?id= | Webcam, scene and talking frames |
#overlay-gauge?id= | Coin Jar and Stream Boss |
#overlay-custom | Custom Widget |
Query parameters
| Parameter | Applies to | Meaning |
|---|---|---|
id | Multi-instance widgets | Which copy this source is. See Overlay widgets for the values |
lang | All | Which language the widget renders in: en, th, zh, ja, hi, es |
lang is independent of the app's language, so you can run English widgets on stream while using Vfinity in another language.
Parameter order
The parameters go after the hash, and they are joined properly:
http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=enNot ?id=goal1?lang=en. A second ? makes the id parse as goal1?lang=en and the widget renders empty. Copy the URL from the widget card and this cannot happen.
Assets
Images and video you upload in Vfinity are served by the same server at /assets/<id>. Widget settings reference them internally, so there is nothing to copy by hand.
Everything is local
The server binds to 127.0.0.1 and rejects connections whose origin is not a local page. Nothing on this port is reachable from the internet, and no overlay data leaves your machine.
The corollary is that the overlays only work while Vfinity is running. Closing the app takes every browser source with it.