Analog key travel from a Wooting keyboard, live in OBS. Each key fills up as you press it, so viewers see how far a key went down, not just that it was hit.
Nothing to install. Open the page, add your keys, and OBS shows them.
- Chrome or Edge, on a desktop computer.
- A Wooting keyboard. Only Wooting is supported for now — other analog keyboards are planned.
- OBS 30 or newer, with its WebSocket server turned on.
https://halcyon.wardensquad.fr
That is the whole installation. Your keys, colours and profiles are saved in your browser, on your machine.
Profiles can follow OBS scenes. Link OBS scenes, in the header, lists the scenes OBS has; pick a profile for each one you care about. When OBS switches to that scene, the profile opens and the overlay follows. Scenes left on “—” change nothing.
The page walks you through three steps.
Plug in your Wooting. If it does not show up on its own, click Choose device… and pick it from the list Chrome shows.
If you later turn gamepad mode on in Wootility, Chrome sees a different device and the page loses the keyboard. Chrome will not ask again on its own: click the keyboard's name at the top of the page and pick the Wooting in the list it shows.
In OBS: Tools → WebSocket Server Settings. Tick Enable WebSocket server and Enable Authentication, and keep the password it shows you.
Type the port and that password into the two fields, then click Copy URL. In OBS, add a Browser source and paste it. Later on, the same fields and the URL are one click away: click OBS at the top of the page.
Two things to know here:
- The first time, Chrome asks for permission to access your local network. Say yes. If you refuse, the app looks exactly as if OBS were switched off — and Chrome does not ask twice. To undo a refusal, click the icon at the left of the address bar, open Site settings, set Local network access to Allow, then reload the page.
- Keep that URL off stream. Your OBS password is in it, and it is also visible in the browser source properties.
Press a key and it appears on the overlay. Press the next one. You can move, resize and recolour them afterwards; Add key at the top starts the capture again whenever you want more.
Under Global style → Behavior → Keys at rest you choose how much of the keyboard shows while your hands are still: the whole thing, the outlines alone, or nothing at all until a key goes down.
Optional. Put a shortcut in your Windows Startup folder — press Win+R and
type shell:startup to open it:
chrome.exe --app=https://halcyon.wardensquad.fr/capture.html
--app opens it as a plain window, without tabs or an address bar.
No. Your keystrokes and your OBS password never reach us. The site sends you a page and nothing else; everything after that happens between your browser and your own OBS. Two people using the site at the same time cannot see each other's keys.
The one thing worth repeating: your OBS password is saved in your browser and appears in the OBS source properties, so don't show that URL on stream.
The overlay stays black in OBS. Check the browser source URL is the one the page gave you, password included. If it went black after an OBS update, see deploy.md — there is a documented way around it.
The overlay stops reacting. Open the OBS pill's popover and click Reload next to Halcyon sources in OBS: the page asks OBS to refresh every browser source pointing at it. The same button is in Diagnostics. Doing it by hand still works — right-click the source in OBS and choose Refresh.
Travel stays at zero. The keyboard is connected but sending nothing: unplug it and plug it back in, then allow it again if Chrome asks.
Nothing happens when you press a key. The two indicators at the top say which link is broken — the keyboard, or OBS and its overlay. An orange one can be clicked to try again.
Click the ⚙ at the top right, open Diagnostics and click Copy log, then paste that into your report. It carries everything needed to understand the problem without asking you three more questions.
Running your own copy, offline use, hosting it yourself: see deploy.md and the releases page.
Halcyon is source-available under the PolyForm Shield License 1.0.0. In plain words:
- Anyone can use it, for free. Streaming, including monetised streaming, is exactly what it is for. Read the code, run your own copy, change it, share your changes.
- You may not offer a product that competes with Halcyon, whether sold, bundled into something else, or hosted for free. If you would like to do that, get in touch for a commercial licence.
- Keep the notice. Copies you pass on must keep the
Required Noticeline at the top of the licence, so people know what they are running.
Halcyon is written and maintained by one person; issues are welcome, pull requests are not. CONTRIBUTING.md explains why.