Skip to content

Update Unreal SDK to websocket 2.0#4497

Open
JasonAtClockwork wants to merge 13 commits intomasterfrom
jlarabie/unreal-sdk-2.0
Open

Update Unreal SDK to websocket 2.0#4497
JasonAtClockwork wants to merge 13 commits intomasterfrom
jlarabie/unreal-sdk-2.0

Conversation

@JasonAtClockwork
Copy link
Contributor

@JasonAtClockwork JasonAtClockwork commented Feb 28, 2026

Description of Changes

  • Updated the Unreal SDK and generated Unreal bindings for the websocket 2.0 protocol/model
    • Reworked DbConnectionBase to handle the updated message shapes
    • Switched subscription handling over to new message types and QuerySetId
    • Updated reducer to ReducerResult, removal of callbacks, and set reducer flags
    • Added event table support
  • Baked in multi-module support replacing the old PR
    • Added functionality to generate module support for multiple folders in the Unreal project (add .Build.cs, .h, .cpp) using the --module-name
    • Add new configuration option for spacetime generate to handle module prefix
  • Regenerated Unreal Blackholio/TestClient/QuickstartChat bindings
    • Rebuilt Unreal Blackholio's consume entity to use event tables

API and ABI breaking changes

  • Unreal websocket/message handling updated to the new protocol
  • Unreal generation now expects a real .uproject target and will stop immediately if project
    metadata is invalid instead of continuing past setup issues.

Expected complexity level and risk

3 - A large set of changes to update the websocket/message handling along with heavy codegen changes to handle multi-module support

Testing

Test coverage of the Unreal SDK will need expansion in a future ticket once our issues with flakiness on CI is resolved.

  • Updated Unreal Blackholio
  • Ran full Unreal SDK test suite
  • Built new test project using the new --module-prefix
  • Run through Unreal Blackholio (C++ and Blueprint)
  • Rebuilt Unreal Blackholio with multi-module, and duplicate generated module testing side-by-side modules that would overlap

Review Question(s)

  • Updates to spacetime init have made the tutorial a little confusing with pathing for the Unreal Blackholio tutorial. To fix though we'd have to update all the commands to be more explicit, or update the tutorial spacetime init to use --project-path . to keep pathing simpler, thoughts?

@JasonAtClockwork JasonAtClockwork self-assigned this Feb 28, 2026
@JasonAtClockwork JasonAtClockwork changed the base branch from jlarabie/cpp-v10 to master March 2, 2026 16:09
@JasonAtClockwork JasonAtClockwork added documentation Improvements or additions to documentation api-break A PR that makes an API breaking change docs deploy whenever Docs updates that aren't tied to a specific release, and should be deployed when convenient. labels Mar 4, 2026
@JasonAtClockwork JasonAtClockwork requested a review from rekhoff March 4, 2026 18:24
@JasonAtClockwork JasonAtClockwork marked this pull request as ready for review March 4, 2026 18:51
@JasonAtClockwork
Copy link
Contributor Author

@jdetter I'll work with you on this for the version bump and make sure that is done and reset up once this is ready to merge.

The changes have not been done yet so this comment will need to be resolved before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api-break A PR that makes an API breaking change docs deploy whenever Docs updates that aren't tied to a specific release, and should be deployed when convenient. documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant