feat(state-replay): experimental state-based session replay - #1479
Draft
mujacica wants to merge 1 commit into
Draft
feat(state-replay): experimental state-based session replay#1479mujacica wants to merge 1 commit into
mujacica wants to merge 1 commit into
Conversation
…pture + viewer) Adds `USentryStateReplaySubsystem`, a self-contained GameInstance subsystem that streams a structured, AI-parseable snapshot of gameplay state to a local JSONL file each frame — an alternative to the video-based session replay that is CPU -cheap, tiny, and queryable, and works where a GPU video encoder can't ship. Per frame it auto-captures: - local pawn transform + camera POV (loc/rot/fov) - transforms of actors registered via AddTrackedActor (id/tag) - the active UMG widget tree: normalized rects, text, hover/disabled, progress % - perf (fps / frame-time) and a game-state channel (auto entity counts + a SetState/SetStateString API) UI interaction is captured at the Slate level via an input pre-processor, so clicks on Blueprint menu buttons are recorded and resolved to widget names even while gameplay is paused. Gameplay code can push semantic events via AddEvent. Ships a zero-dependency local player (tools/state-replay-player) that reconstructs the session in 3D with low-poly stand-in assets and a player-POV camera (2D top-down fallback), plus a UMG UI overlay, FPS/entity telemetry, a click-to-seek event timeline, and a one-click AI session digest. Scope: local developer/AI-debugging tool. Does not touch the crash pipeline or upload anything (crash-attachment is a deliberate follow-up). Standalone subsystem — not part of the platform interface, so no Null stubs required. Config: Project Settings -> Plugins -> "Sentry State Replay" (disabled by default). Sentry.Build.cs: +UMG, +DeveloperSettings, +InputCore. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Instructions and example for changelogPlease add an entry to Example: ## Unreleased
### Features
- experimental state-based session replay ([#1479](https://github.com/getsentry/sentry-unreal/pull/1479))If none of the above apply, you can opt out of this check by adding |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
USentryStateReplaySubsystem, a self-contained GameInstance subsystem that streams a structured, AI-parseable snapshot of gameplay state to a local JSONL file each frame — an alternative to the video-based session replay that is CPU -cheap, tiny, and queryable, and works where a GPU video encoder can't ship.Per frame it auto-captures:
UI interaction is captured at the Slate level via an input pre-processor, so clicks on Blueprint menu buttons are recorded and resolved to widget names even while gameplay is paused. Gameplay code can push semantic events via AddEvent.
Ships a zero-dependency local player (tools/state-replay-player) that reconstructs the session in 3D with low-poly stand-in assets and a player-POV camera (2D top-down fallback), plus a UMG UI overlay, FPS/entity telemetry, a click-to-seek event timeline, and a one-click AI session digest.
Scope: local developer/AI-debugging tool. Does not touch the crash pipeline or upload anything (crash-attachment is a deliberate follow-up). Standalone subsystem — not part of the platform interface, so no Null stubs required.
Config: Project Settings -> Plugins -> "Sentry State Replay" (disabled by default).
Sentry.Build.cs: +UMG, +DeveloperSettings, +InputCore.