Skip to content

Commit de9bc16

Browse files
committed
Expand prerequisites
1 parent ea868af commit de9bc16

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

docs/platforms/godot/configuration/stack-traces.mdx

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,41 @@ description: "Learn how to get readable stack traces in Sentry with Sentry SDK f
55

66
Debug information files allow Sentry to extract stack traces and provide additional information about crash reports. In order to get readable stack traces in Sentry when your game crashes, you need to export your project using an export template that contains debug information. For the official builds, Godot Engine only provides templates without debug symbols. This guide covers how to create such templates and use them to export your project with full debug information available in Sentry.
77

8-
To get debug information, we need to compile export templates with debug symbols produced. You'll need **SCons** build tool, Python, and a C++ compiler for your target platform installed.
8+
## Prerequisites
99

10-
<Alert>
10+
To get debug information, we need to compile export templates with debug symbols produced. You'll need Git, SCons build tool, Python, and a C++ compiler for your target platform installed.
11+
12+
Ensure you have a compatible C++ compiler. On Windows, for instance, you can use [Visual Studio Community 2022](https://visualstudio.microsoft.com/) with the C++ workload installed.
13+
14+
Here are a few ways to install the **SCons** build tool:
15+
16+
```PowerShell {tabTitle:Windows}
17+
# If you have `scoop` installed:
18+
scoop install scons
19+
```
20+
21+
```bash {tabTitle:macOS}
22+
# If you have Homebrew installed:
23+
brew install scons
24+
```
1125

12-
On Windows, for instance, you can use [Visual Studio Community 2022](https://visualstudio.microsoft.com/) with the C++ workload installed.
26+
```bash {tabTitle:Arch Linux}
27+
pacman -S scons
28+
```
29+
30+
```bash {tabTitle:Ubuntu/Debian}
31+
sudo apt install scons
32+
```
33+
34+
```bash {tabTitle:Using Python}
35+
# Install with existing Python installation:
36+
python -m pip install scons
37+
38+
# Upgrade:
39+
python -m pip install --upgrade scons
40+
```
41+
42+
<Alert>
1343

1444
For more information, refer to [Building from Source](https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html) in the official Godot documentation. It provides detailed instructions for compiling Godot on different platforms and with different tools. This guide offers streamlined instructions tailored for our use case, and may omit some details you require.
1545

0 commit comments

Comments
 (0)