You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/platforms/godot/configuration/stack-traces.mdx
+66-12Lines changed: 66 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ Debug information files allow Sentry to extract stack traces and provide additio
11
11
12
12
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.
13
13
14
+
For Android, you'll also need the Android SDK (command-line tools are enough). On macOS, don't use the Android SDK provided by Homebrew as it will not be installed in a unified location.
15
+
14
16
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, GCC on Linux and Clang on macOS.
15
17
16
18
Here are a few ways to install the **SCons** build tool:
@@ -45,7 +47,7 @@ For compiling on macOS you also need to install [Vulkan SDK](https://sdk.lunarg.
45
47
46
48
<Alert>
47
49
48
-
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.
50
+
For more information, refer to [Building from Source](https://docs.godotengine.org/en/stable/engine_details/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.
49
51
50
52
</Alert>
51
53
@@ -55,20 +57,38 @@ Start in a terminal with Git available. Clone Godot Engine repository and switch
55
57
```bash
56
58
git clone https://github.com/godotengine/godot
57
59
cd godot
58
-
git checkout 4.4-stable
60
+
git checkout 4.5-stable
59
61
```
60
62
63
+
<Expandabletitle="Additional Setup for Android">
64
+
65
+
For Android compilation, Godot requires the Swappy frame pacing library. Download the pre-built library from [https://github.com/godotengine/godot-swappy/releases](https://github.com/godotengine/godot-swappy/releases) and extract the archive contents to the `thirdparty/swappy-frame-pacing/` directory within your cloned Godot source tree.
66
+
67
+
</Expandable>
68
+
61
69
## Compiling Templates
62
70
63
-
To compile the Godot release export template with debug symbols, run the following command:
71
+
To compile the Godot export templates with debug symbols, run the following commands:
-`production`: set build defaults for production use
79
99
-`debug_symbols`: include debugging symbols in the build
80
100
-`separate_debug_symbols`: extract symbols into a separate file
81
-
-`generate_bundle`: generate an APP bundle `godot_macos.zip` after building macOS binaries
101
+
-`generate_bundle`: generate application bundle archive (`godot_macos.zip` for macOS or `godot_ios.zip` for iOS)
102
+
-`generate_android_binaries`: generate Android template AARs and Gradle template project after build is complete (`android_source.zip`)
82
103
83
104
For more information, run: `scons --help`
84
105
85
106
</Expandable>
86
107
87
-
If all goes well, the export template files should appear as the result of the build process in the `bin/` directory inside the Godot source tree. When using MSVC on Windows, you will find `.exe` files alongside `.pdb` files, which contain debug information. On macOS, you will find `godot_macos.zip` containing a universal binary supporting both x86_64 and ARM64 architectures and also two folders ending with `.dSYM` containing debug information bundles for each architecture.
108
+
After a successful build, the export template files will be generated in the `bin/` directory within the Godot source tree:
**macOS:** The build generates `godot_macos.zip` containing a universal binary that supports both x86_64 and ARM64 architectures. Additionally, you'll see two separate `.dSYM` folders (debug symbol bundles) for each architecture.
113
+
114
+
**iOS:** The build generates `godot_ios.zip` containing universal frameworks with static libraries and Xcode project files for both release and debug export configurations.
115
+
116
+
**Android:** The build produces `android_source.zip`, which contains the Gradle build template with the compiled export template libraries. Additionally, the build generates `android-template-release-native-symbols.zip` and `android-template-debug-native-symbols.zip` archives containing the corresponding debug symbols for each template variant.
88
117
89
118
<Alert>
90
119
@@ -94,13 +123,32 @@ Learn more about debug formats in [Debug Information Files](/platforms/native/da
94
123
95
124
## Exporting Project
96
125
97
-
Now you can export your project using your custom template. In the Godot **Export** dialog window, follow these steps:
126
+
With your custom templates compiled, you can now export your project with debug symbols. Open the Godot **Export** dialog and configure it as follows:
127
+
128
+
1. Select or add an export preset for your target platform.
129
+
130
+
2. Enable **Advanced Options** in the top-right corner of the dialog.
131
+
132
+
3. Configure the custom template in the **Options** tab:
133
+
134
+
**For Windows/Linux:**
135
+
- Find the **Custom Template** section
136
+
- Under **Release**, browse and select your compiled template executable from the `bin/` directory
137
+
138
+
**For macOS**
139
+
- Find the **Custom Template** section
140
+
- Under **Release**, browse and select `godot_macos.zip` bundle from the `bin/` directory
98
141
99
-
1. Select or add an export preset.
100
-
2. Enable the **Advanced Options**toggle.
101
-
3. In the **Options**tab, under **Custom Template -> Release**, assign your custom template executable file.
142
+
**For iOS:**
143
+
- Find the **Custom Template**section
144
+
- Under both **Release**and **Debug**, browse and select the same `godot_ios.zip` bundle from the `bin/` directory
102
145
103
-
This will configure your project to use the custom export template with the debug symbols you compiled earlier.
146
+
**For Android:**
147
+
- Enable **Gradle Build** in the **Gradle** section
148
+
- Set **Android Source Template** to point to the `android_source.zip` file generated during compilation
149
+
- Install the Android build template by navigating to **Project > Install Android Build Template...** in the editor menu
150
+
151
+
Once configured, your export preset will use the custom template containing the debug information needed for readable stack traces in Sentry.
This uploads debug information files from the `bin` directory to Sentry, creating the source bundles on the fly.
160
208
209
+
<Alerttitle="Important note for iOS">
210
+
211
+
For iOS projects, you must export your project to a directory first, then run the `sentry-cli debug-files upload` command on that exported directory rather than the `bin/` directory. This is necessary because Godot uses an Xcode project with static libraries for iOS exports, and the debug symbols are only available after the export compilation process is complete.
0 commit comments