Queue overlay for OBS
The overlay shows on stream which song is playing now and which are next. It updates by itself when you change the order or mark songs as played, so you do not need to reload the source.
The overlay is one page of the site, bardway.com/overlay/<your-address>, which can show several
blocks at once: the song queue, the Learn draw results, coin events and the Activity roulette.
How to add it to OBS
The main link shows all blocks as one scene: the blocks stand on a 1920×1080 frame where you put them in "Position on screen", and the whole scene scales to the size of the source.
- In OBS open "Settings → Video", the "Base (Canvas) Resolution" field (in newer OBS versions it may be called "Preview (Canvas) Resolution"): it is usually 1920×1080.
- In Settings → Overlay copy the "All blocks: queue, draw, events and roulette" link. In OBS, under "Sources", add a "Browser" source and paste the link.
- In the source properties set the width and height to match the canvas: 1920 and 1080. On the overlay page you can copy these numbers with buttons.
- If the source turned out a different size: right-click the source, "Transform", "Fit to Screen" (Ctrl+F, Cmd+F on macOS). Any 16:9 size works, the picture stays right.
- The position, offsets and sizes of the blocks are changed on the overlay page, not in OBS.
The same instructions are on the overlay page under the link: "How to add it to OBS: 6 steps".
Changes in the overlay settings are picked up in about 10 seconds. You do not need to reload the source. At the top of the overlay page there is a preview with a demo queue; it stands where "Position on screen" puts it. "Full frame" shows the proportions of the stream, and "Zoom" shows the overlay at actual size.
The link looks like this:
https://bardway.com/overlay/<address>?blocks=queue,learn,events,roulette&key=<key>&layout=frame.
The layout=frame parameter turns the scene on, and blocks sets which blocks it contains.
Position on screen
In Settings → Overlay → Position on screen you see a reduced stream frame with a 3×3 grid and the real blocks in their places.
- Choose a block: Queue, Learn draw, Events or Roulette. Under the name you can see whether it is on and where it stands.
- Click a cell of the grid and the block moves there. Icons in the cells show where the other blocks are. You can also pick a taken cell. If two enabled blocks stand in one cell and, judging by their sizes, overlap, a warning appears; move them apart with offsets and it goes away.
- Move the block more precisely:
- Horizontal offset and Vertical offset: a shift in frame pixels from the place in the cell (plus is right and down, minus is left and up, up to ±960 and ±540);
- Width: for the queue, "Auto" (520) or from 200 to 1920; for the draw from 480 (1100 by default); for events from 240 (720 by default); for the roulette from 400 (880 by default, the whole strip scales);
- Maximum height for the queue and the draw: "Auto" up to the frame edge, or your own number; anything extra is cut off.
- "Reset to default" returns the block to its original place and size.
It saves by itself. By default the queue is at the top right, the draw at the top left, events at the top center, the roulette at the bottom center. A block that is off is drawn faded, and you turn it on on the page of its feature: there is a link to it next to the block name.
Until you change the queue width in the layout (and after "Reset to default"), it is taken from "Size" (see below).
Blocks
- The Queue (
queue) always works, no key is needed. - The Learn results (
learn) show the draw you start on the "Learn" page. The block appears only if "Show the results in OBS" is switched on in Settings → Song learning. More: Learn a song. - Events (
events) show how viewers pay with minted coins: a coin drops from above and a short caption appears next to it. The block appears if "Activities" are switched on and "Show events in the overlay" is on in them. More: Activities and minted coins. The caption holds only the nickname of the confirmed platform or the word "Anonymous", no balances. Up to three events are on screen at once, each for seven seconds, without sound. Events that happened before the source was opened are not shown. - The Roulette (
roulette) shows the Activity roulette: a thin fretboard strip. At rest the strip shows the progress and the number of ready spins (including those bought by viewers for coins); when a spin starts, the strip moves and stops on the result, and the result stays until you press "Done" or spin again. After the roulette is reset, the result disappears from the strip. Without sound. The block appears if the roulette is switched on in Settings → Activities. More: Activity roulette.
A block that you have not switched on on the site will not appear on stream, even if it is in the link. The places of the blocks are no longer chosen on the "Learn" and "Activities" pages: those have only switches, and the position is set on the overlay page.
If live learning is on, the block with songs "outside the setlist" stands first on the overlay, above the queue (no songs, no block), and is separated from the queue by a thin line labelled "Queue" (with a fixed height, only the line, so that rows are not cut off). Its rows and the "Learning" label count towards "Songs in the list" (see below), and one place is always left for the current song. For requests that a viewer put on hold, the queue shows an "Away" mark with a countdown; the song is not hidden.
Old links and separate links per block
- Links pasted into OBS earlier keep working, but they ignore the position on screen: the blocks stay in their old places relative to the size of the source. To make the blocks follow the layout, replace the link in the source with the main one.
- The "More: separate links per block" section of the overlay page keeps separate links: "Queue only" and "Learn draw results only". They work the old way, each in its own 1920×1080 source: the queue at the top right, the results window where it stood before (top left by default). Offsets and width from the layout do not apply to them.
Key
The results and events blocks are opened by the key in the link. The key is private, do not show the links on stream. If a link ended up in the wrong place, press "Change key" under the links and confirm. All previous links stop showing results and events (the queue keeps working), and new links appear on the same page: paste them into OBS again. The owner and the administrators can see and change the key.
In the demo project the links are not shown.
Moving from Twitch extension links
Before, the link led to the Twitch extension page (…/twitch_extension/obs.html?project=<address>).
Now the queue lives on the site, and the Twitch extension is responsible only for the panel.
- Old links keep working: they redirect automatically to the queue (
?blocks=queue). - Events and Learn results will not open through an old link, because it has no key. To turn them on, replace the link with a new one from Settings → Overlay.
- If you used an old link, you will get a bell notification "New OBS links". The date until which old addresses will keep working has not been set yet.
What you can configure
Colors
Choose a ready theme (BardWay, Sunset, Fire, Neon, Violet, Ocean, Mint, Mono) or "Custom": the main color, the second gradient color and the background opacity. For a single-tone gradient, use the same color twice.
Size
- Songs in the list. The rest collapse into a "+N" line. The rows of the live learning block and its label count too; one place is always left for the current song.
- Width. "Auto" follows the size of the source. In the main link the queue width is taken from here until you set it in "Position on screen".
- Height. "Auto" fits the content; a fixed height cuts off extra rows.
Effects
- Evaporate on removal: a played or removed song dissolves and the others glide up.
- New request notification: for a few seconds a "song — who requested it" card appears next to the overlay. Position: left, below or right. If the queue stands at the bottom edge of the frame, "below" notifications appear above it.
Stream timer
You can show a countdown above the queue.
- In the overlay settings switch on "Show the stream timer" and set the duration.
- If you like, switch on autostart: after the stream starts or after the queue opens.
- You can start and reset the timer on the "General" page.
When it reaches zero, the timer blinks until it is reset. A running timer is not restarted when the stream reconnects or the queue is reopened.
Plans
The standard overlay theme, the Learn results and coin events are available on Free. Full overlay customization is part of Pro. Details: Plans.
FAQ
Do I need to refresh the source in OBS after changing settings?
No. Changes are picked up in about 10 seconds.
What size should the source be?
The same as the OBS canvas, usually 1920×1080. If the source is a different size, choose "Transform → Fit to Screen" (Ctrl+F, Cmd+F on macOS): any 16:9 size works. Do not use "Resize Output (Source Size)": it changes the resolution of the broadcast.
The blocks on stream are huge or have shifted
Most likely the source has an old link without the scene, and the source itself is stretched over the frame. Copy the main link again, set the source to the canvas size and choose "Fit to Screen".
Can I show the overlay in the Twitch extension too?
The queue appearance settings also apply to the overlay of the Twitch extension. The OBS link itself is not connected to the extension: it is a page of the site.
Why is there a key in the link?
The key opens the events and Learn results blocks; the queue does not need it. Without a key, or with a wrong key, these blocks are empty.
Do I need to replace the old obs.html link?
Not necessarily: it works and shows the queue. Replace it with the main link if you want events, results and the roulette in one source and the block layout.