@ue-shed/unreal-connection
v0.4.0
Published
Typed Remote Control and companion transport adapters for UE Shed hosts.
Downloads
529
Readme
@ue-shed/unreal-connection
Typed Remote Control connectivity, companion capability negotiation, reconnect behavior, and bounded data-plane helpers for headless UE Shed hosts. It depends on protocol contracts, not domain UIs or Workbench.
npm install --save-exact @ue-shed/unreal-connection @ue-shed/protocol [email protected]Node.js 22.14 or newer is required. The package exposes one stable entry point:
import {
RemoteControlClient,
RemoteControlClientLive,
connectUnrealAuthoring
} from "@ue-shed/unreal-connection";The first implemented adapter negotiates UEShedCore over Remote Control HTTP and exposes authoring
snapshot, Apply, operation lookup, and Save capabilities as typed Effect operations. Every HTTP
envelope and nested companion JSON result is runtime-validated. Calls have explicit timeouts, typed
retry guidance, and structured spans.
Map Review hosts use the same RemoteControlClient surface for camera and review editor calls.
This package does not install Unreal plugins, launch Workbench, or own review schemas.
License
MIT. Unreal Engine is a trademark of Epic Games, Inc. This project is not affiliated with or endorsed by Epic Games.
