Docs / Getting started
[FOUNDER COPY — getting-started H1]Getting started.
[FOUNDER COPY — getting-started intro]Lorem ipsum — here's the shortest path from “empty OBS scene” to “Hakalachi overlay live on your stream.”
1. Connect your Twitch account
Sign in at the dashboard with your Twitch account. We use Twitch OAuth (the official way) and request the minimum scopes Hakalachi needs to read chat, detect alerts, and update your stream info.
Lorem ipsum — we never see your password. You can revoke access at any time from your Twitch connections page.
2. Copy your overlay URL
Once connected, each overlay (chat, alerts, goals, BRB, etc.) has its own unique URL tied to your account. Copy it from the dashboard.
https://overlay.hakalachi.com/u/<your-key>/chat
Treat this URL like a password — anyone with it can render your overlay. You can rotate it from your account settings if it ever leaks.
3. Add it as an OBS browser source
- In OBS, click + under Sources → select Browser
- Paste the overlay URL from step 2
- Set width 1920, height 1080
- Check Shutdown source when not visible
- Check Refresh browser when scene becomes active
- Click OK
4. Go live
That's it. The overlay connects automatically and stays in sync with your Twitch events. Lorem ipsum — if anything looks off, refresh the browser source in OBS.
Scope and permissions
[PLACEHOLDER: list final Twitch OAuth scopes Hakalachi requests, in the order presented during sign-in, with one-sentence explanations of each.]
Troubleshooting
- Overlay shows nothing.Lorem ipsum — check that the URL is exactly as displayed in the dashboard, and that your Twitch connection still shows green.
- Alert sounds don't play.Lorem ipsum — OBS browser sources start muted by default in some setups. Right-click the source → Properties → uncheck mute on visible.
- Chat looks delayed.Lorem ipsum — brief delay during reconnect after Twitch IRC drops is expected. Persistent delay means a refresh.