Endless Dream can connect to OBS Studio over the OBS WebSocket protocol and automatically switch scenes and control recording as you move between game states. Scene assignments are configured per game state in the launcher, so the correct OBS scene loads whenever you enter music select, start a song, reach the result screen, and so on.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/seraxis/lr2oraja-endlessdream/llms.txt
Use this file to discover all available pages before exploring further.
This feature requires the OBS WebSocket plugin. OBS Studio 28 and later ships with the WebSocket server built in (protocol version 5). If you are running an older version of OBS, install the obs-websocket plugin separately.
Setup
Enable the OBS WebSocket server in OBS
In OBS, go to Tools → WebSocket Server Settings. Enable the server and note the port (default
4455) and password if authentication is enabled.Enable the integration and enter connection details
Check Enable OBS WebSocket integration. Enter the host (typically
localhost), port, and password to match your OBS WebSocket server settings.Connect to OBS and load your scenes
Click Connect. The launcher connects to OBS, displays the detected OBS and WebSocket versions, and populates the scene dropdowns with the names of your OBS scenes. If authentication fails, the label will indicate the failure so you can correct your password.
Assign scenes and actions to game states
The OBS tab shows a row for each game state:
For each state, choose an OBS scene from the dropdown (or leave it as (No Change)) and an optional action — Start Recording or Stop Recording — from the action dropdown (or leave it as (Do Nothing)).Scene switches happen immediately when the game transitions to that state. Recording actions trigger at the same time as the scene switch.
| Game state | Description |
|---|---|
MUSICSELECT | Music select screen |
PLAY | Song gameplay |
PLAY_ENDED | Immediately after gameplay ends, before the result screen |
RESULT | Music result screen |
DECIDE | Decide screen |
COURSESELECT | Course select screen |
COURSERESULT | Course result screen |
Configure recording save behavior
Use the Recording mode dropdown to control which recordings are kept:
- Always keep recordings — every recording is saved, regardless of what you do in-game.
- Keep on screenshot — a recording is only kept if you take a screenshot during that session. Recordings without a screenshot are deleted when the next recording starts.
- Keep on replay save — a recording is only kept if a replay is auto-saved during the session.
How recording save modes work
When the recording mode is set to Keep on screenshot or Keep on replay save, the game manages recording in a stop-and-restart loop across game states. At each state transition where a stop action is configured, the recording stops. If the save condition was met during that segment (screenshot taken or replay auto-saved), the file is kept. If not, the file is deleted when the next recording starts. An in-game notification confirms whether the last recording was saved or discarded.The Always keep recordings mode records continuously and never deletes any files. Use one of the conditional modes only if you specifically want to filter your recordings by screenshot or replay activity.