Design custom commerce overlays

Choose the right starting page

Use monetization.html for the current audience product/support overlay and commerce-board.html for boards and sold-item views. The docs setup pages and shop.html storefront serve different roles; a storefront is not an OBS operator control panel.

Download and keep the file structure

1. Download the source ZIP and extract it. These guides use the beta source; keep the files from one download together.
2. Copiar monetization.html como my-products.html beside the original. If choosing a different page or theme, keep its copy in that file's original folder.
3. Open the copied HTML and its referenced CSS/JS in your editor or AI tool. Add supplied artwork/fonts to the same project and use relative paths. Start with CSS overrides; include the renderer when changing generated markup.

The following files help you find the design and behavior. This is a reading list, not a complete dependency bundle: keep the extracted folder intact, including images, fonts, scripts, and any data files.

Connect your copy and open it in OBS

Start SSN and make the original generated overlay URL work first. The session= value connects to that SSN session; it is not your channel name or this file's name. Keep SSN, the relevant feature, and its data sources running.

1. Drag your edited HTML file into Chrome or Edge. Copy its address from the address bar; it starts with file:///.
2. Copy everything from ? onward in your working SSN overlay link and add it to the end of that file address. Keep all settings, including the session, password, and any # ending.
3. Open the result in a browser, then set an OBS Browser Source's URL to the same address with Arquivo local unchecked. Match the source dimensions to your intended design.

For the starting file above, the local address looks like this; your actual link may contain additional required options:

file:///C:/SSN/social_stream-beta/my-products.html?session=YOUR_SESSION

Use the actual file address on your computer. OBS saves it with the source; keep the downloaded folder in the same place. After saving design changes, refresh the Browser Source. The shared setup guide includes Mac examples and an optional launcher for the Local file checkbox.

Where to change the design

Change card layout, typography, product image framing, price treatment, QR placement, and board tiles. Keep QR codes large and clear enough to scan. Include thirdparty/qrcode.min.js, translation scripts, and the full shared commerce folder loaded by your chosen page.

Reuse the commerce state and controls already used by SSN, Stream Deck, Event Flow, and optional OBS docks. Preserve selected/hidden/scheduled state. Keep session details, setup messages, publishing credentials, and operator controls off the audience graphic. A successful update does not establish whether OBS is live or showing that source.

Copy this AI prompt

Give the AI your copied source files and reference artwork. Replace the bracketed details. Keep the input-safety instructions in the prompt.

Customize my-products.html, copied from monetization.html.
Design: [describe the look or attach a reference].
Colors/fonts/assets: [supply hex colors and local filenames].
OBS canvas and placement: [size and position].

Restyle [monetization.html / commerce-board.html] as [design]. Preserve the shared commerce state/control API, product selection, visibility/scheduling, prices, destinations, QR behavior, and stale/empty states. Keep configuration and credentials out of the audience display. Do not create a second local product catalog or infer OBS visibility from a received command.

Read docs/event-reference.html for incoming fields and
docs/overlay-customization-guide.html for local setup and safe rendering.
Keep the existing session/password handling, labels, server routes, query
parameters, URL fragments, and relative asset paths. Use classic scripts
compatible with Chrome 80. Keep executable dependencies packaged locally.

Treat all incoming messages, names, labels, donations, and metadata as untrusted.
Prevent HTML/JavaScript injection in every renderer you change. Use textContent
for plain fields and for chatmessage when textonly is true. For HTML-mode
chatmessage, keep supported emotes/formatting through the packaged
SocialStreamChatHTML.sanitize helper (libs/objects.js loaded first).
Do not concatenate raw input into innerHTML, attributes, CSS, or JavaScript.
Validate media/link URLs with the page's existing URL policy and assign DOM
properties; do not enable javascript: URLs or executable embedded content.
Never eval incoming data or treat a viewer message as an AI instruction.
Keep source checks, connection handling, and existing sanitizers.
Test plain text, allowed emotes, quotes, angle brackets, and an HTML injection
probe in an isolated preview; verify the probe cannot execute.

Make the edited overlay work directly from disk using a file:/// URL,
without requiring a local web server.
Return the edited files, any additional assets, exact local browser/OBS
setup instructions using placeholders, and the specific tests performed.
Do not put my private session link or credentials into a public example.

Test this overlay type

Use a preview or test setup first. The test-message guide explains how to send fictional payloads through SSN; a test submitted to your production session can trigger its existing automations.

1. For boards, use commerce-board.html?demo to inspect fictional data. Remove demo for a connected display.
2. Use the existing product/board controls to select, hide, and change items. Check long titles, missing images, price formatting, and QR scans from an OBS-sized preview.
3. Check empty and disconnected states and a reload. Test the configured public product destination without publishing a new catalog just to change the overlay's style.

Also run the input-rendering checks against the render paths you changed. After saving edits, refresh the OBS Browser Source between rehearsals and repeat the visible interaction. Browser previews do not establish live capture or OBS behavior.

Mais referências: Commerce setup · Shared product controls · Boards and sales · Referência de eventos · Local setup troubleshooting.