Built-in WebSocket server for exposing real-time game data

[iSweat-exe]

I would like to request the addition of a built-in WebSocket server inside osu!, configurable from the Debug section of the settings under a new category named “WebSocket”.

This section could include:

• A toggle: Enable WebSocket Server
• A customizable host/port (e.g. ws://localhost:24050)
  Once enabled, the WebSocket server would broadcast real-time game state data such as:

{
  "state": "Playing",
  "mode": "osu!mania",
  "beatmap": "Camellia - Exit This Earth's Atomosphere",
  "score": 512345,
  "accuracy": 98.45,
  "combo": 412,
  "max_combo": 1150,
  "pp_current": 245.23,
  "pp_ss": 310.45
}

Why this is useful

This would make it far easier for the community to create tools and projects related to osu! (such as overlays, stream integrations, and more) without relying on fragile workarounds like memory reading or parsing internal files.

Because the WebSocket interface would remain consistent across versions (unless there are major game changes), it would:

• Simplify external development,
• Prevent breakage between updates,
• Encourage more creative, real-time projects built safely around osu!.

Example use cases:

• Live OBS overlays showing PP and accuracy in real-time
• Integration with IoT (lighting, etc.)
• Local dashboards or stream widgets displaying performance stats

Summary

Adding a small optional WebSocket server, disabled by default and exposed through the Debug settings, would provide a clean, official, and stable way to retrieve real-time game information, benefiting both developers and content creators across the osu! community.

Thank you for considering this idea and for your continued work on osu! ❤️

I’ve developed a prototype of the interface this idea could have.

[bdach]

#18129