diff --git a/docs/platforms/nintendo-switch/index.mdx b/docs/platforms/nintendo-switch/index.mdx index 99e92a848ad3d..165a65505bdc5 100644 --- a/docs/platforms/nintendo-switch/index.mdx +++ b/docs/platforms/nintendo-switch/index.mdx @@ -10,8 +10,7 @@ categories: -You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unreal/game-consoles/) with Nintendo Switch. - + ---- "Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo. diff --git a/docs/platforms/playstation/index.mdx b/docs/platforms/playstation/index.mdx index 50e4eadb257c8..f6aa6eed88a5b 100644 --- a/docs/platforms/playstation/index.mdx +++ b/docs/platforms/playstation/index.mdx @@ -10,7 +10,7 @@ categories: -You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unreal/game-consoles/) with PlayStation. + PlayStation support is exclusive to our SaaS offering, as it depends on confidential components that cannot be distributed for self-hosted use. diff --git a/docs/platforms/unity/game-consoles/index.mdx b/docs/platforms/unity/game-consoles/index.mdx index dfa6485e8d653..0036f95f49737 100644 --- a/docs/platforms/unity/game-consoles/index.mdx +++ b/docs/platforms/unity/game-consoles/index.mdx @@ -4,11 +4,33 @@ description: "Learn how to configure your Unity SDK to capture errors on Xbox, P sidebar_order: 7 --- -Sentry supports [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) via the Unity SDK. Once you submit the middleware verification process, we'll reach out and send you an invite to our private GitHub repositories with console specific code. +## How It Works + +The Unity SDK is a hybrid integration built on top of the [.NET SDK](/platforms/dotnet/). The C# layer captures managed exceptions and enriches events with context, while platform-specific native SDKs capture native crashes. Both layers synchronize scope data bidirectionally. + +On console platforms, the Unity SDK and console SDK work together: + +- The **C# layer** captures managed exceptions and adds context (breadcrumbs, tags, user data) +- The **console layer** captures native crashes via platform-specific mechanisms +- Scope data syncs between layers so native crashes include your C# context + +Each console has a different crash capture model: + +| Platform | How crashes are captured | +| ------------------- | -------------------------------------------------------- | +| **Xbox** | SDK integration via Microsoft's GDK (similar to Windows) | +| **PlayStation** | Crash reports flow through Sony's servers to Sentry | +| **Nintendo Switch** | Nintendo's crash reporting forwards directly to Sentry | + +## Getting Started + +Sentry supports [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) via the Unity SDK. Once you submit the middleware verification process, we'll reach out and send you an invite to our private GitHub repositories with console-specific code. This allows your configuration and custom data set via C# to show up in C# exceptions as well as crash dumps on these console platforms. -Access to Sentry's error and crash reporting for consoles is a paid feature. We will review the pricing and details with you during the verification process. + Access to Sentry's error and crash reporting for consoles is a paid feature. + We will review the pricing and details with you during the verification + process. ## Nintendo Switch @@ -23,7 +45,7 @@ Access to Sentry's error and crash reporting for consoles is a paid feature. We ----- +--- "Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo. "Microsoft", "Xbox" are trademarks of the Microsoft group of companies. diff --git a/docs/platforms/unreal/game-consoles/index.mdx b/docs/platforms/unreal/game-consoles/index.mdx index f67da45d6c856..cf28b3c1e118c 100644 --- a/docs/platforms/unreal/game-consoles/index.mdx +++ b/docs/platforms/unreal/game-consoles/index.mdx @@ -4,14 +4,34 @@ description: "Learn how to configure your SDK to capture errors on Xbox, PlaySta sidebar_order: 7 --- -Sentry supports [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) via the Unreal Engine SDK extensions. Once you submit the middleware verification process, we'll reach out and send you an invite to our private GitHub repositories with console specific code. +## How It Works + +The Unreal SDK is a thin C++ wrapper that provides a consistent Unreal-friendly API (C++ and Blueprints) while delegating to platform-specific SDKs underneath: [sentry-native](/platforms/native/) on Windows/Linux, [sentry-cocoa](/platforms/apple/) on macOS/iOS, and [sentry-java](/platforms/java/) on Android. + +On console platforms, the Unreal SDK and console SDK work together: + +- The **Unreal layer** provides the API for adding context (breadcrumbs, tags, user data) +- The **console layer** captures native crashes via platform-specific mechanisms + +Each console has a different crash capture model: + +| Platform | How crashes are captured | +| ------------------- | -------------------------------------------------------- | +| **Xbox** | SDK integration via Microsoft's GDK (similar to Windows) | +| **PlayStation** | Crash reports flow through Sony's servers to Sentry | +| **Nintendo Switch** | Nintendo's crash reporting forwards directly to Sentry | + +## Getting Started + +Sentry supports [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) via the Unreal Engine SDK extensions. Once you submit the middleware verification process, we'll reach out and send you an invite to our private GitHub repositories with console-specific code. This allows your configuration and custom data set via C++ or Blueprints to show up in non-fatal events as well as crash dumps on these console platforms. -Access to Sentry's error and crash reporting for consoles is a paid feature. We will review the pricing and details with you during the verification process. + Access to Sentry's error and crash reporting for consoles is a paid feature. + We will review the pricing and details with you during the verification + process. - ## PlayStation @@ -24,7 +44,7 @@ Access to Sentry's error and crash reporting for consoles is a paid feature. We ----- +--- "PlayStation", "PS5" are registered trademarks or trademarks of Sony Interactive Entertainment Inc. "Microsoft", "Xbox" are trademarks of the Microsoft group of companies. diff --git a/docs/platforms/xbox/index.mdx b/docs/platforms/xbox/index.mdx index f7216782be22c..705bc7e56d07b 100644 --- a/docs/platforms/xbox/index.mdx +++ b/docs/platforms/xbox/index.mdx @@ -10,12 +10,11 @@ categories: -You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unreal/game-consoles/) with Xbox. + Access to Sentry's error and crash reporting for consoles is a paid feature. We will review the pricing and details with you during the verification process. - ---- "Microsoft", "Xbox" are trademarks of the Microsoft group of companies. diff --git a/includes/console-intro/game-engine-integration.mdx b/includes/console-intro/game-engine-integration.mdx new file mode 100644 index 0000000000000..2f2cf142fadf2 --- /dev/null +++ b/includes/console-intro/game-engine-integration.mdx @@ -0,0 +1,8 @@ +## Using with Game Engines + +If you're using Unity or Unreal Engine, use the game engine specific SDK instead of integrating the console SDK directly. The game engine SDKs wrap the console SDK and provide engine-specific features: + +- [Sentry SDK for Unity on consoles](/platforms/unity/game-consoles/) - captures C# exceptions and syncs context with native crashes +- [Sentry SDK for Unreal Engine on consoles](/platforms/unreal/game-consoles/) - provides C++ and Blueprint APIs on top of the console SDK + +For custom engines or native C++ games, integrate the console SDK directly as described above.