Repository navigation
On Stream Widgets
Four widgets go on your stream. Each is a web page served by CrossChat on your own PC, so add it wherever your streaming app takes a web page. The widgets are transparent, so your scene shows through.
| Widget | Address | Suggested size | What it shows |
|---|---|---|---|
| Chat feed | http://127.0.0.1:4466/overlay/chat |
450 × 800 | The merged chat |
| Featured message | http://127.0.0.1:4466/overlay/featured |
900 × 260 | One message you pick, big |
| Viewer counter | http://127.0.0.1:4466/overlay/viewers |
600 × 120 | Everyone watching, in total and per platform |
| Alerts | http://127.0.0.1:4466/overlay/alerts |
800 × 300 | Subs, gifts, raids, cheers, Super Chats and more |
CrossChat must be running for them to show anything. With OBS it starts by itself.
OBS: Sources → + → Browser, paste the address as the URL, and set the width and height.
Streamlabs Desktop: Sources → + → Browser Source.
Other apps: add it the way your app adds a web page.
Use the http://127.0.0.1:4466/... address rather than a local file. OBS 33's browser blocks pages opened as local files from reaching anything on 127.0.0.1.
The Theme Studio builds these addresses for you. Each widget card has a button that copies the address with your theme in it. It is called Copy address.
Hover any message in the chat window and press show. It appears big on stream. Hide in the window, or the OBS hotkey, takes it off.
Alerts look the same whichever platform they come from. Change the wording, which types show and the chime in the Theme Studio.
The chime plays through the browser source. In OBS, tick Control audio via OBS in the source's properties to give it its own volume slider and send it to your stream. Otherwise only you hear it, through your desktop audio.
Add these to one source's address to override its theme. Start with ? and join with &, for example ?theme=neon&size=26.
| Option | Example | Does |
|---|---|---|
theme |
theme=neon |
Theme file name |
platforms |
platforms=twitch,youtube |
Chat feed: only these platforms |
size |
size=26 |
Text size in pixels |
layout |
layout=compact |
card, bubble, line or compact
|
icons |
icons=text |
Platform shown as icon, text, bar or none
|
max |
max=5 |
Chat feed: messages on screen |
seconds |
seconds=0 |
Chat feed: seconds each message stays; 0 stays |
direction |
direction=top |
Chat feed: newest at the bottom or top
|
align |
align=right |
Chat feed and viewer counter: left or right
|
delay |
delay=10 |
Chat feed: seconds each message waits before it shows |
scale |
scale=2 |
Featured message: size compared with chat text |
opacity |
opacity=0.5 |
Background opacity, 0 to 1 |
badges |
badges=off |
Hide mod, sub and member badges |
sound |
sound=off |
Alerts: no chime |
volume |
volume=0.2 |
Alerts: chime volume, 0 to 1 |
demo |
demo |
Show made-up data without going live |
The full list and every theme setting are in docs/THEMES.md.
delay gives you time to delete a message before it reaches the stream. A message deleted or filtered during the wait never shows. The featured message never waits, because you picked it.
- The send-test button on each widget card in the Theme Studio puts a test message, featured message, viewer count or alert on the real sources in your scene. It is called Send test.
- Add
?demoto an address to see made-up data.
-
Nothing shows: CrossChat isn't running, or nothing has happened yet. Try a test, or add
?demo. -
The theme didn't change: save it in the Studio, and check the address names the right
?theme=. - Old look after an update: right-click the source → Refresh cache of current page.
Get started
Use it
Reference
Help
Developers