Skip to content

Commit 2ac1bb7

Browse files
bruno-garciaantonpirker
authored andcommitted
Add Unity and platform-specific console documentation for Sentry (#14075)
1 parent 5ce1602 commit 2ac1bb7

File tree

8 files changed

+70
-54
lines changed

8 files changed

+70
-54
lines changed

docs/platforms/nintendo-switch/index.mdx

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,10 @@ categories:
88
- gaming
99
---
1010

11-
<PlatformContent includePath="getting-started-primer" />
11+
<Include name="console-intro/nintendo-switch" />
1212

13-
To get started using Sentry in your Nintendo Switch games, you can go to [CRPORTAL](https://crash-report.wc.lp1.er.srv.nintendo.net/sentry/get_started).
14-
No changes to the game are required, as you can configure Nintendo's servers to start forwarding your crashes to Sentry.
15-
Support for both devkit as well as retail devices are available.
13+
You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unity/game-consoles/) with Nintendo Switch.
1614

17-
If you want to add additional context to your crash dumps or you want to capture non-fatal events, Sentry offers an SDK specifically for Nintendo Switch.
18-
It allows for adding additional context such as [breadcrumbs](/product/issues/issue-details/breadcrumbs/) and [tags](/product/issues/issue-details/#tags).
19-
To get access to the SDK, please reach out via the [Nintendo Developer Authorization](https://developer.nintendo.com/group/development/getting-started/g1kr9vj6/middleware/sentry) form.
20-
Or via [Sentry Support](https://sentry.zendesk.com/hc/en-us/requests/new).
21-
22-
---
15+
----
2316

2417
"Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo.

docs/platforms/playstation/index.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,9 @@ categories:
88
- gaming
99
---
1010

11-
<PlatformContent includePath="getting-started-primer" />
11+
<Include name="console-intro/playstation" />
1212

13-
No changes to the game are required, Sentry will pull crashes and additional data such as screenshots automatically.
14-
Support for both devkit as well as retail devices are available.
15-
16-
To start using Sentry in your PS5 games, you can head over to the [Sentry page inside PlayStation Partners](https://game.develop.playstation.net/tm/verify/functionalsw) and confirm your developer status by clicking on *Confirm status*.
17-
18-
We'll receive your request and get back to you with the next steps.
13+
You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unity/game-consoles/) with PlayStation.
1914

2015
----
2116

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Game Consoles
3+
description: "Learn how to configure your Unity SDK to capture errors on Xbox, PlayStation and Nintendo Switch."
4+
sidebar_order: 7
5+
---
6+
7+
Sentry supports [PlayStation](https://docs.sentry.io/platforms/playstation/), [Xbox](https://docs.sentry.io/platforms/xbox/) and [Nintendo Switch](https://docs.sentry.io/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.
8+
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.
9+
10+
11+
## Nintendo Switch
12+
13+
<Include name="console-intro/nintendo-switch" />
14+
15+
## Xbox
16+
17+
<Include name="console-intro/xbox" />
18+
19+
## PlayStation
20+
21+
<Include name="console-intro/playstation" />
22+
23+
----
24+
25+
"Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo.
26+
"Microsoft", "Xbox" are trademarks of the Microsoft group of companies.
27+
"PlayStation", "PS5" are registered trademarks or trademarks of Sony Interactive Entertainment Inc.

docs/platforms/unreal/game-consoles/index.mdx

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,24 @@ description: "Learn how to configure your SDK to capture errors on Xbox, PlaySta
44
sidebar_order: 7
55
---
66

7-
Sentry supports [PlayStation](https://docs.sentry.io/platforms/playstation/), [Xbox](https://docs.sentry.io/platforms/xbox/) and [Nintendo Switch](https://docs.sentry.io/platforms/nintendo-switch/) via the Unreal Engine SDK extensions. The access to these is given by sending an invite to private repositories on GitHub after you complete the middleware verification process.
7+
Sentry supports [PlayStation](https://docs.sentry.io/platforms/playstation/), [Xbox](https://docs.sentry.io/platforms/xbox/) and [Nintendo Switch](https://docs.sentry.io/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.
8+
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.
89

9-
## Xbox
10-
11-
To start using Sentry Unreal Engine SDK extension in your Xbox games [complete Microsoft Game Development Kit (GDK) Middleware verification process](https://developer.microsoft.com/en-us/games/support/request-gdkx-middleware).
12-
13-
We'll receive your request and get back to you with the next steps.
14-
15-
----
16-
17-
"Microsoft", "Xbox" are trademarks of the Microsoft group of companies.
1810

1911
## PlayStation
2012

21-
To start using Sentry Unreal Engine SDK extension in your PS5 games head over to the [Sentry page inside PlayStation Partners](https://game.develop.playstation.net/tm/verify/functionalsw) and confirm your developer status by clicking on *Confirm status*.
13+
<Include name="console-intro/playstation" />
2214

23-
We'll receive your request and get back to you with the next steps.
15+
## Xbox
2416

25-
<Alert>
17+
<Include name="console-intro/xbox" />
2618

27-
Crash capturing on PlayStation doesn't require the Unreal Engine SDK, but in order to add tags and other context, you'll need to install it along with the corresponding plugin extension.
19+
## Nintendo Switch
2820

29-
</Alert>
21+
<Include name="console-intro/nintendo-switch" />
3022

3123
----
3224

3325
"PlayStation", "PS5" are registered trademarks or trademarks of Sony Interactive Entertainment Inc.
34-
35-
## Nintendo Switch
36-
37-
To get started using Sentry in your Nintendo Switch games, you can go to [CRPORTAL](https://crash-report.wc.lp1.er.srv.nintendo.net/sentry/get_started).
38-
No changes to the game are required, as you can configure Nintendo's servers to start forwarding your crashes to Sentry.
39-
40-
If you want to add additional context to your crash dumps or you want to capture non-fatal events, Sentry offers an Unreal Engine SDK extension specifically for Nintendo Switch.
41-
It allows for adding additional context such as [breadcrumbs](/product/issues/issue-details/breadcrumbs/) and [tags](/product/issues/issue-details/#tags).
42-
To get access to the corresponding plugin extension, please reach out via the [Nintendo Developer Authorization](https://developer.nintendo.com/group/development/getting-started/g1kr9vj6/middleware/sentry) form.
43-
Or via [Sentry Support](https://sentry.zendesk.com/hc/en-us/requests/new).
44-
45-
---
46-
47-
"Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo.
26+
"Microsoft", "Xbox" are trademarks of the Microsoft group of companies.
27+
"Nintendo", "Nintendo Switch" are trademarks or registered trademarks of Nintendo.

docs/platforms/xbox/index.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,10 @@ categories:
88
- gaming
99
---
1010

11-
<PlatformContent includePath="getting-started-primer" />
11+
<Include name="console-intro/xbox" />
1212

13-
Sentry supports Xbox via a customized version of the [Native SDK](/platforms/native).
14-
Support for both devkit as well as retail devices are available.
13+
You can also use Sentry's [Unity](/platforms/unity/game-consoles/) and [Unreal Engine SDKs](/platforms/unity/game-consoles/) with Xbox.
1514

16-
To start using Sentry in your Xbox games, you can [request Microsoft Game Development Kit (GDK) Middleware access](https://developer.microsoft.com/en-us/games/support/request-gdkx-middleware).
17-
18-
We'll receive your request and get back to you with the next steps.
19-
20-
---
15+
----
2116

2217
"Microsoft", "Xbox" are trademarks of the Microsoft group of companies.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
You can get started using Sentry on Nintendo Switch without any changes to your game, on devkits as well as retail devices.
2+
3+
It can be done directly on Nintendo's CRPORTAL. The two environments available are [lp1 for retail devices](https://crash-report.wc.lp1.er.srv.nintendo.net/sentry/get_started)
4+
and [dd1 for devkits](https://crash-report.wc.dd1.er.srv.nintendo.net/sentry/get_started).
5+
In both cases you can configure Nintendo's servers to start forwarding your crashes directly to Sentry.
6+
7+
If you want to add additional context to your crash dumps, or you want to capture non-fatal events, Sentry offers an SDK specifically for Nintendo Switch.
8+
It allows for adding additional context such as [breadcrumbs](/product/issues/issue-details/breadcrumbs/) and [tags](/product/issues/issue-details/#tags).
9+
To get access to the SDK, please reach out via the [Nintendo Developer Authorization](https://developer.nintendo.com/group/development/getting-started/g1kr9vj6/middleware/sentry) form.
10+
11+
Support for Switch 2 as well as the original Switch is available.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
You can get started using Sentry on PlayStation without any changes to your game, on devkits as well as retail devices.
2+
3+
Configuration can be done in your Sentry project settings, on a new page called PlayStation that is made available to you once the middleware verification process is done.
4+
5+
The verification process starts [inside the PlayStation Partners website](https://game.develop.playstation.net/tm/verify/functionalsw) where you can confirm your developer status by clicking on *Confirm status*.
6+
We'll receive your request and get back to you with the next steps.
7+
8+
9+
Even though crash dump collection doesn't require a Sentry SDK, if you add it, you can get additional context in your crash dumps, as well as capture non-fatal events.
10+
Sentry offers SDK support specifically for PlayStation so you can add context such as [breadcrumbs](/product/issues/issue-details/breadcrumbs/) and [tags](/product/issues/issue-details/#tags).

includes/console-intro/xbox.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
You can get started using Sentry by [requesting Microsoft Game Development Kit (GDK) Middleware access](https://developer.microsoft.com/en-us/games/support/request-gdkx-middleware).
2+
We'll receive your request and get back to you with the next steps.
3+
4+
Support is available on Xbox Series X and S, by adding the Sentry SDK to your game.
5+
Crash collection as well as non-fatal events can be captured, on devkits as well as retail devices.

0 commit comments

Comments
 (0)