Auction wheel

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

What this page is

Auction wheel prepares the OBS overlay that spins the auction wheel and announces the result. It lives at Auction → Wheel overlay. As the hint under the title puts it, "The engine picks the result; this widget only renders the animation. Recommended OBS size: 1280 x 720."

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. What the On air switch does is in the section "Hiding the wheel from the stream" below.

1. In Link parameters on the left there are three switches, all on to begin with: Sector labels, Result caption and Winner amount. Turn one off and press Save Settings: only then does the link carry it.
2. After saving, press Copy link in the header and paste the address into an OBS Browser Source. A link copied before saving still carries the old switches. At the default size the wheel is as large as the source allows with room left for the result plaque under it; to make it larger or smaller inside the same source, use Wheel (step 6).
3. The Styling card above the section list holds ready-made looks and your own. Open "-- Choose a template --" and take one from Built-in (Neon, Minimal, Retro and the twelve themes) or from Mine — this overlay and Mine — from other overlays. The line under the list says what Apply will do.
4. To keep the current look, type a name into Template name in the same card and press Save. Delete removes a saved template of your own. Picking one of your own templates puts its name back into the field and Save reads Update: saving then overwrites that template instead of leaving a second copy behind.
5. The sections under it are the wheel taken apart: Wheel, Rim, Sector labels, Pointer, Hub, Result plaque, Material, Outline effect, Winner caption, Result, Amount and Edge padding. Pick one and its fields open on the right.
6. Wheel holds a single slider, Size, % of the fit, from 30 to 150 and 100 by default. At 100 the wheel is as large as the source allows with room left for the result plaque under it; lower makes it smaller inside the same source, and above 100 it grows further, so the wheel or its plaque can go past the source edges, which the source frame in OBS shows before you go live. Edge padding has Top and bottom and Left and right, in pixels: the space kept free between the source edge and the wheel with its plaque.
7. Rim has Rim background, Width, % of wheel and Glow. Pointer has Fill and Size, % of wheel. Hub has Background, Border, Size, % of wheel and Mark color.
8. Result plaque is the frame around the announcement: Background, Radius, % of wheel, Padding, % of wheel, Border, Glow and Winner glow, the pulse the auction winner gets. Event effect set to Electric runs a lightning border around the plaque when a result comes up, with Effect Color, Effect duration, Effect Speed and Effect Chaos; None turns it off. In OBS the plaque always pops in and the winner glow pulses, even with animation effects switched off in Windows: that setting is about your own screen, so it calms the plaque only in the preview here and in the Auction: Wheel tile. Material dresses this plaque in one of the twelve themes; the wheel itself, with its rim, sectors and hub, keeps its usual look. Under a theme the colour of the lot that came up moves into the theme's trim in place of the plaque border, so the plaque still points to its sector; under Clear glass and Frosted glass that colour does not show. Border is hidden while a theme is on, and under some themes Glow and Winner glow are too, because the theme draws them itself. Outline effect runs around the plaque: in Plays, All the time keeps it going and On event flashes it at the moment a lot comes up. Event effect keeps working next to it. How themes and effects work in general is in the guide "Styling an Overlay".
9. Sector labels, Winner caption, Result and Amount each carry Font, Size, % of wheel, Weight, Color and Shadow. Result is the winner's name, Winner caption the line over it, Amount the line under it.
10. Inside a glow or shadow field there is a checkbox Winning lot colour. Ticked, that layer takes the colour of the sector that came up instead of a fixed colour.
11. Nothing is written until you press Save Settings in the header: the note over the preview says "Changes stay here until you press Save." Once saved, a source already added to OBS takes the new look by itself. The three switches from step 1 are the exception: they live in the link, so after changing them copy the link again. Back to list with unsaved changes asks first.
12. - and + over the preview zoom it in and out. This changes the preview only. Reset appearance in the header puts the default look back on screen; it is written only when you press Save Settings.

Hiding the wheel from the stream

There are two ways, and they do different things.

The eye on the tile hides every wheel until the next spin. While bids are being collected, the wheel does not have to be on screen. On the Control Panel, the Auction: Wheel tile has an eye button in its corner, Hide the wheel from the stream. Click it and the wheel fades out in OBS and in the tile, while the OBS source stays on and bids keep coming in. The tile then reads "The wheel is hidden from the stream. Hiding it does not stop bids, and Spin shows it again." and offers Show the wheel; the eye button brings it back too.

You do not have to show the wheel before the draw: Spin shows a hidden wheel by itself and then spins it. A hidden wheel stays hidden after the app restarts.

The On air switch takes one wheel off the stream until you switch it back. It sits at the start of the wheel's row in the list, and the hint under the title says what it does: "The switch in a row turns off only that wheel: it disappears from OBS and stays hidden even when you press Spin. The auction and the other wheels keep running." It acts at once, without Save Settings, and the row is marked Off. The wheel goes together with its plaque and outline effect and stops redrawing on bids. The Auction: Wheel tile and the wheel on Auction → Wheel do not follow the switch. Switched back on, the wheel shows the current auction and the last result; if a draw is still spinning, the winner appears when that spin ends. A wheel deleted from the list goes dark the same way, even if its link is still in OBS.

If the wheel has vanished from OBS while its source is on, check three places. The Auction: Wheel tile: instead of a hidden wheel it shows the note above. The wheel's row in the list: a wheel switched off is marked Off. And the power button on Auction: Control: the wheel appears only after the auction reports its state, so while the auction is switched off or not running at all, the source stays empty from the moment the scene loads.

What it cannot do

• The draw is not run from here. Lots, modes and the spin itself live on the Auction page; this widget only draws what the engine sends.
• The parts of the wheel are sized as a percent of the wheel, not in pixels, so the picture keeps its proportions in a source of any size. Only Edge padding is in pixels.
• The Auction: Wheel tile on the Control Panel always shows sector labels, the result caption and the winner amount. The three switches from step 1 live in the OBS link, and the tile does not use that link, so turning them off changes the stream, not the tile.
• Sector labels are only drawn on sectors wide enough to hold them, and no more than forty of them at once.
• A long winner name is cut to two lines with an ellipsis, so that the plaque does not push the wheel off the screen.
• The plaque keeps the last result on screen: incoming bids do not wipe it, and it is replaced by the next spin or by Restart on the Auction page. Before the first spin it reads "The wheel is ready", and during one "Spinning".
• The captions themselves — "Auction winner", "Eliminated", "Advances", "{n} left", "match {done} of {total}", "total {total}" — cannot be rewritten; only their font, size, weight, colour and shadow are yours.