Carousel Overlay

Installed separately, as part of the Carousel bundle: this module does not come with the app installer. Open Module Catalog → Add-ons and press Install on the Carousel card, and the bundle installs all of its modules at once.

What this page is

Carousel Overlay is the ribbon of cards that goes on the stream — "The ribbon of cards for OBS: it stops on the card the engine picked". It lives at Carousel → Carousel overlay. The page decides how the ribbon looks and sounds; what is on the cards and when it spins is decided on the Carousel page.

How to set it up

The page opens on the list of widgets, not on the settings. Create widget sits above it; the first widget is called Main and a new one arrives as New widget. Each row has an On air switch, the widget's name, a one-line summary of its settings and the buttons Copy link, Duplicate, Delete and Configure. Delete appears only once there are two, because the last widget cannot be removed. Configure opens the settings described below and takes you back to the list. Every widget keeps its own link and its own look, so two of them can stand in different scenes at the same time.

On air off takes that ribbon off the stream at once, without Save Settings: it leaves the frame and stays silent, even in the middle of a spin, and the row is marked Off. The pool keeps collecting, and spins still count and reach the history, the pool bar and the other ribbons. The hint above the list says it plainly: "The switch turns off only this ribbon: the pool keeps collecting and spins go on. To stop the carousel itself, use the “Carousel: Control” tile on the Control Panel". So with every ribbon off, viewers keep paying for spins they cannot see. Switched back on, the ribbon returns to its resting place without the slide-in sound, and a spin that ran while it was off is not replayed. A ribbon deleted from the list goes dark the same way, even if its link is still in OBS.

1. Open Carousel → Carousel overlay. Copy overlay link in the header copies the address, and the message confirms it: "The link is copied — paste it into a Browser Source in OBS". A size of 1200 x 400 suits it.
2. The preview fills the middle of the page and shows your real cards, laid out with the odds they actually have. Before any cards exist it shows four samples.
3. Above the preview: Spin plays one spin, Loop repeats it until you press Stop, and Hide takes the ribbon away so you can see how it leaves — the button then reads Show. The − and + on the right (Zoom out / Zoom in) scale the preview.
4. The sections are listed down the left: Backdrop, Pointer, Animation, Card, Card text, Winning card and Sounds. Pick one and its fields open on the right. That list is the one you get with Styling on All cards. Choose any single rarity in Styling and the column shortens to four — Card, Card text, Winning card and Sounds — because the backdrop, the pointer and the animation belong to the ribbon as a whole and cannot differ per rarity. The preview narrows with it, showing only cards of that rarity; with none of that rarity yet, it shows the four sample cards dressed in its look.
5. Backdrop is the space the ribbon lives in — Background, Ribbon position (Top, Middle, Bottom), Corner radius, Padding. Pointer is the marker the ribbon stops under: Color, Size, Shadow.
6. Animation is how the ribbon comes and goes: How the ribbon appears (Slides in from below, Slides in from above, Grows in place, Just fades in), How long it takes to appear, and the matching How the ribbon leaves and How long it takes to leave.
7. Card holds Background, Border, Corner radius, Card size, Gap between cards and Shadow. Card text holds Font, Size, Weight, Color, Letter case and Shadow.
8. Winning card is what happens to the card the ribbon stops on: Glow, Zoom, Dim the others, Movement of the winning card (None, Pulses, Flashes, Shakes), and a Border effect — None or Electric, with Effect color, Effect speed and Effect chaos.
9. Above the fields on the right, and only while you are on Card, Card text or Winning card, there is a picker labelled Styling. Leave it on All cards to dress every card at once, or pick a rarity — Common through Artifact — to give that rarity a look of its own. The line under it says which you are doing. A rarity that already has its own look is marked with a dot in the list, and Back to the shared look deletes it after asking.
10. Sounds has four moments, each with its own sound slot: When the ribbon slides in, While the ribbon spins — "A short click per card, slowing down together with the ribbon" — When the card comes up, and When the ribbon leaves, "The quietest of the four — often left empty". Volume is shared by all four. The ▶ in a slot plays the sound here on the page. Clicking the slot opens the Choose a sound window: any folder can be opened there, and the chosen file is copied into the app's sounds folder (Settings → Sound). The sounds belong to this carousel alone. A new carousel starts with no sound at all, and Duplicate gives the copy the same sounds as the carousel it was made from. A new pick is written when you press Save Settings.
11. Drop sound per rarity below them replaces the drop sound for one rarity — "Left empty, the shared one plays".
12. Press Save Settings in the header. It writes everything on the page at once: the look of every section, the sounds and the name. When you save, a change made on All cards reaches the rarities that have a look of their own. Back to list with unsaved changes asks first.
13. Ready-made looks and your own saved templates sit in a card of the same name at the top of the left column, above the section list. Open "-- Choose a template --", take one from Built-in, Mine — this overlay or Mine — from other overlays, and press Apply; Template name with Save keeps the current look, Delete removes one of yours. The card is there whatever Styling is picked, and it acts on what is picked: All cards dresses the whole overlay, a rarity dresses that rarity alone. Built-in is the one part that comes and goes — it is listed while the shared look is the one being dressed, and gone once the rarity you are on has a look of its own.

What it cannot do

• The overlay draws nothing by itself. It shows what the Carousel page sends it, so an empty ribbon in OBS means the engine has no cards switched on, not that the link is wrong. A ribbon missing from OBS altogether may also be switched off with On air, deleted from the list, or out of the frame because the carousel is switched off.
• The result is decided by the engine before the ribbon starts moving. Reloading the Browser Source mid-spin does not change the card, and nothing on this page can influence it.
• How long the spin lasts, how long the winning card is held and whether the ribbon hides between spins are set on the Carousel page, not here. A ribbon that stays on screen the whole stream has Hide the ribbon when there is nothing to spin off there.
• With the carousel switched off on Carousel: Control, the ribbon leaves the frame whatever Hide the ribbon when there is nothing to spin says, after finishing a spin that was already playing. Switch the carousel back on and the ribbon returns to its usual resting place.
• Backdrop, Pointer, Animation and Sounds are shared by the whole overlay. Only Card, Card text and Winning card can differ per rarity — there is one ribbon, and it cannot slide in one way for one card and another way for the next.
• Sounds cannot be set per card or per group, only per rarity, and only for the moment the card comes up.
• How wide the ribbon is comes from the Browser Source in OBS — this page has no width field. Where it sits is split between the two: Ribbon position here places it inside the source, and OBS places the source on the canvas.
• Each carousel overlay in the list has its own link, look and sounds; add another one with Create widget or Duplicate.
• The pool bar is not part of this overlay — it is a separate one, on the Pool bar overlay page, added to OBS as its own Browser Source.