18-LAB / Documentation
Your first overlay
1. Start the backend
Start vosu or a tosu-compatible backend separately. Install the counters you want in that backend. vosulay discovers its counter catalog; it does not replace the backend.
By default vosulay connects to http://127.0.0.1:24050/. For a different origin, open Settings → Advanced → vosu URL, enter its HTTP(S) scheme, host and port, click Save, then restart vosulay. Backend API paths are absolute: do not use a path-prefix deployment.
2. Launch vosulay and the game
Launch Vosulay from your application menu or run its executable. On Linux, startup refreshes recognized osu! shortcuts for the next launch; if attachment does not work for an already running game, restart it through the refreshed shortcut. See Linux attachment.
Focus osu!stable or osu!lazer. The active game follows focus rather than process launch order. Launching vosulay a second time does not create another instance.
3. Open the editor
With the game focused, press Ctrl+Shift+Space. This is the default Toggle edit mode shortcut. You can also choose Edit mode in the tray, then focus the game.
During editing, vosulay receives keyboard and pointer input instead of the game. Editing normally ends when the game loses focus. Editor behavior explains interaction and focus settings.
4. Add and arrange a counter
- Find the counter in Installed counters. Search counters matches name, author or folder.
- Click its catalog entry to add it to the active profile.
- Drag it into position. Select it to use resize handles or the Counter properties inspector.
- Use X, Y, Width, Height, Scale, Layer, Opacity % and Rotation for exact placement.
For custom web pages, use Add URL or HTML file instead. See Overlays before loading untrusted content.
5. Finish and check saving
Placement edits save automatically. The toolbar reports Saving… and then Saved; resolve a save error before assuming a layout is retained. Click Done, press Escape with no dialog/menu consuming it, or use the edit toggle to return to the game. App settings use their own Save button.
The default profile is Default and starts empty. Create more layouts in Profiles.
Missing or blank counters? Follow Troubleshooting.
Sources: README, editor controls, saving behavior.