Docs › Tools › Christmas Lights

Tools docs

Christmas Lights

Decorative string lights along the edges of your stream.

The overlay hangs strings of lights along the edges of your stream: a wire that swags between pins, with bulbs on it that glow and animate. It is drawn by the page itself, with no pictures to download, over a transparent background. It needs no account and no key, and it asks no other service for anything.

Build it

Open the Christmas Lights builder, from the Tools page or from the Christmas & Winter section of Seasonal tools. The preview at the top is the real overlay. Change a setting and it reloads a moment later. Copy URL and Open work as soon as at least one edge is ticked. See Add a tool to OBS for the browser source.

Where the lights hang

Edges
Tick Top, Right side, Bottom and Left side. Each edge you tick gets its own string. The top is ticked to start.
Spacing between bulbs (px)
From 20 to 200. The start is 56. A longer edge holds more bulbs at the same spacing, up to a limit.
Wire sag (px)
From 0 to 100. The start is 24. How far the wire swags into the frame between its pins. Zero makes it straight. The bulbs sit on the wire.
Wire color
A dark green to start.

The bulbs

Bulb colors
Up to six. The bulbs take turns through them along the string. Use Add a color and Remove the last, or start from Classic, Warm white, Icy blue or Red and green.
Halloween
The 🎃 Halloween button fills in orange and purple bulbs, a dark wire, a stronger glow and the Creepy pattern in one go. Change any of them afterwards. Opening the builder with ?preset=halloween after its address starts from this look.
Bulb size (px)
From 6 to 60. The start is 18.
Glow
From 0 to 100. The start is 60. How far the light of each bulb spreads. Zero is no glow.

Animation

Pattern
Steady keeps every bulb at full brightness. Twinkle has each bulb swell and fade at its own pace, and is the start. Blink has the even bulbs and the odd bulbs take turns. Chase runs a bright front round the string with a fading tail. With several edges ticked, a chase runs along the top from left to right, down the right side, back along the bottom and up the left side. Creepy has the bulbs flicker at random, with no steady rhythm, and now and then a bulb stutters and goes out completely for a few seconds before it comes back. Only a small share of the bulbs is ever out at once, so the string never goes dark all together.
Speed
From 1 to 100. The start is 50. A steady string does not use it.

Landscape and portrait

The overlay lays its strings out for the size of the browser source, so set the source to the size of your stream's frame, such as 1920 by 1080 for landscape or 1080 by 1920 for portrait. A portrait frame holds more bulbs down its sides and fewer along its top. In the builder, Landscape and Portrait only change the shape of the preview, and they are not part of the link.

Performance

Use it with other overlays

Christmas Lights is its own browser source. It does not depend on any other seasonal overlay, so you can add it beside Snowfall or any other overlay as separate sources and stack them in the order you like.

Advanced: change it in the link

Everything the builder does is a setting in the link after the #. Your browser does not send that part to our server. Only settings you change are written, so a link with no settings at all is the starting string along the top.

SettingValuesStarts as
edgesany of t, r, b, lt
colorsup to six colors joined by dashes, such as e0393e-2fbf71red, green, blue, yellow
spacing20 to 200 pixels56
size6 to 60 pixels18
glow0 to 10060
sag0 to 100 pixels24
animsteady, twinkle, blink, chase, creepytwinkle
speed1 to 10050
wirea color such as 1d3b2adark green

A setting that is missing or not valid takes its start value, and a number outside its range is held to the nearest end of it. A value in colors that is not a color is skipped.