Migrating Streaming to webstation
Emulator streaming used to mean one container per emulator, each running its own broker mod (pcsx2-romm-integration, dolphin-romm-integration, xemu-romm-integration, rpcs3-romm-integration). Going forward, streaming goes through a single docker-webstation container running romm-broker, which can serve every platform RomM streams from one place instead of one container per emulator.
The per-emulator broker mods are deprecated
A config.yml container without protocol: webstation still works today, but will stop being supported in a future release.
Why
- One container to run and update instead of N forks of the same broker pattern, each drifting slightly.
- One save-state and memory-card contract instead of five slightly different ones.
- A platform pool (
platforms:on one container) claims whichever instance is free, instead of every platform being pinned to its own single container.
Migrating your config.yml
Before, one container per platform:
streaming:
containers:
- platform: ps2
host: https://192.168.1.51:3001
broker_host: http://192.168.1.51:8000
label: PCSX2
memory_card_sync: true
- platform: ngc
host: https://192.168.1.52:3001
broker_host: http://192.168.1.52:8000
label: Dolphin
After, one webstation container serving both:
streaming:
containers:
- host: https://192.168.1.56:3010
protocol: webstation
subfolder: /streaming
library_path: /romm
label: Emulation station
platforms:
ps2:
emulator: pcsx2
label: PCSX2
memory_card_sync: true
ngc:
emulator: dolphin
label: Dolphin
The full field reference lives in Configuration File → streaming.
Migrating your containers
- Stand up docker-webstation with romm-broker mounted at your ROM library path (use the same path your old per-emulator containers used, so save/state history keyed to it doesn't reset).
- Point
library_pathinconfig.ymlat that same mount. - Move each platform you were streaming into the new container's
platforms:map (see the before/after above). - Confirm streaming works for each platform, then remove the old per-emulator containers.
- Restart RomM. Every container is on the new shape once none of them is missing
protocol: webstation.
Per-emulator notes
Save data, memory cards, and BIOS/firmware requirements don't change, only which container runs the emulator. See the "Migrating to webstation" section in:
Related
- Emulator Streaming: the setup guide for streaming as a whole
- Configuration File →
streaming: every key thestreamingblock accepts