Install your creature in OBS with the free script

Before you start

• A LiveGotchi account and a creature hatched in the Nursery.
• OBS open on the scene where the creature should appear: the script works on the current scene.
• The LiveGotchi Stream page open in your browser, on the “OBS and Twitch” tab.

Install with the OBS script

1. On the “OBS and Twitch” tab, in the “Install in OBS” block, click “Download the script (livegotchi-obs.lua)”. The same file downloads from the virtual companion for Twitch page, or at livegotchi.com/livegotchi-obs.lua.
2. In the same block, under “This Gotchi's key”, click “Copy”. The “Show” button reveals it, “Hide” masks it again.
3. In OBS, open Tools ▸ Scripts, click “+” and choose the livegotchi-obs.lua file.
4. Select the script in the list. The script itself is in French: paste the key into the “Jeton d'overlay” field, and leave “Adresse du site” set to https://livegotchi.com.
5. Click “Installer LiveGotchi”. The script answers under the button with a line such as “Scène « scene name » : 5 sources ajoutées, 0 mise à jour.”, meaning five sources added and none updated.

If a LiveGotchi overlay source already exists anywhere in your scenes, the script picks up the token by itself: step 4 comes down to a click.

What the script places in the scene

• The overlay: a browser source named “LiveGotchi”, at the top left, at the base size of your OBS canvas. If OBS does not report that size, the script uses 1920 × 1080.
• Four widgets, stacked on the left: “LiveGotchi — évolution” (420 × 200), “LiveGotchi — besoin” (320 × 150), “LiveGotchi — jauges” (340 × 230) and “LiveGotchi — identité” (380 × 130). The counters widget (420 × 130) is not placed by default: it starts at zero for a new creature.
• The “Read access to OBS status information” permission: it lets the page know the stream has started, without a password.

The script recognises a source by its address, never by its name. Running it again therefore updates existing sources, even renamed or set up by hand, instead of creating new ones, and reloads each updated source. The starter widgets are only placed if the scene has none yet.

The script launches no program and does not read the state of the stream: it places and completes browser sources, nothing more.

Set up the browser source by hand

The script is not required. To do it all yourself:

1. On the Stream page, “Overlay” tab, “OBS addresses” block, copy the “Overlay address, to paste into an OBS browser source”.
2. In OBS, under Sources, click “+” and add a Browser source.
3. Paste the address into the URL field.
4. Give the source the width and height of your canvas base resolution, the one in the OBS video settings.
5. Set the page permissions to “Read access to OBS status information”.

Widgets no longer need a source each: they are placed in the “Scene” tab of the Stream page, on that same source. One address instead of five, and the old widget addresses keep working. Composing the scene is covered in Build your OBS overlay with drag and drop.

Check that the creature counts the stream

• Airtime is counted in OBS, through the browser source and its “Read access to OBS status information” permission: no password is asked.
• Settings: the overlay rereads them every 4 seconds while live and every 30 seconds off air. A source that stops moving reloads with the “Refresh” button of the OBS browser source.
• Chat: on the “OBS and Twitch” tab, tick “Read the Twitch chat” and fill in the “Channel name” so messages feed the creature. Linking Twitch, with a six-letter code, adds follows, subscriptions and raids.
• obs-websocket stays optional: it only makes the creature walk on the scene's sources. Its address and password go in the “OBS connection” block; the password is in OBS, under Tools ▸ WebSocket Server Settings ▸ Show Connect Info. The “Test the connection” button confirms the link.

Precautions during a stream

The overlay and widget addresses contain your token. Never show on screen the open script, the key, or the properties of a LiveGotchi source. And an address copied without its token never updates: that is the mistake the script avoids.

Frequently asked questions