Design custom tip jars and goals

Choose the right starting page

The Tip Jar / Goal Meter can present different metrics and styles from the same tipjar.html. First configure the intended metric in SSN, then keep that generated URL when changing the design. Hype scoring in this goal is different from the viewer/chatter counter in hype.html.

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. Kopieren tipjar.html auf my-goal.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 Lokale Datei 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-goal.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 the jar artwork, fill colors, bar track, goal label, amount typography, and completion animation. Start with the existing style and color controls described in the goal guide. For custom artwork, keep the assets beside your copy and update only its referenced path.

The goal's metric, completion/reset rules, persistence, and donor counting belong to its behavior. Keep these while changing presentation. Do not convert raw coins, gifted subscriptions, and USD into one unlabelled number. Preserve a numeric donoValue of zero when the source supplies it.

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-goal.html, copied from tipjar.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].

Style this tip jar/goal as [design] for [canvas]. Change artwork, colors, layout, labels, and motion while preserving the chosen metric, amount calculation, source filters, streak handling, persistence, and completion/reset rules. Keep hasDonation display units and donoValue USD semantics. Do not fabricate progress when the feed is empty.

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. Try the page's preview mode (?preview with your style options) first; remove preview when connecting the real session.
2. Use sample support events matching the chosen metric. Check zero, partial progress, goal reached, and progress beyond the goal.
3. Check reset/carryover settings and a source refresh between rehearsals. Inspect currency labels, long titles, and any sound or completion effect in OBS.

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.

Weitere Informationen: Metrics and goal controls · Donation fields · Ereignisreferenz · Local setup troubleshooting.