Skip to content

Commit 82b1886

Browse files
committed
Godot: Add page for Android support
1 parent 9925023 commit 82b1886

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Loading
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Android Support
3+
description: "Learn how the Godot SDK handles Android support."
4+
sidebar_order: 100
5+
---
6+
7+
The Sentry SDK for Godot provides comprehensive support for reporting script errors, native crashes, and custom events on Android platform.
8+
9+
## What We Support
10+
11+
The Sentry Godot SDK supports most essential features when running on Android:
12+
13+
- **Script Errors**: Capture and report GDScript runtime errors with full stack traces.
14+
- **Native Crashes**: Detect and report native C++ crashes that occur in the Godot engine or native extensions.
15+
- **Custom Events**: Track custom events and gameplay interactions.
16+
- **Tags**: Add custom tags to categorize and filter events.
17+
- **Breadcrumbs**: Automatic and manual breadcrumb tracking for debugging context.
18+
- **Contexts**: Device, OS, and application context information, as well as Godot-specific context and custom contexts added by developers.
19+
- **Attachments**: Include additional files and data with error reports.
20+
21+
## Getting Started
22+
23+
Setting up Sentry for Android exports requires using Godot's Gradle build system. The Sentry SDK automatically integrates with your Gradle project, but you need to set up the Android build template first.
24+
25+
### Prerequisites
26+
27+
Before you can export to Android with Sentry support, you must:
28+
29+
1. **Set up Android SDK**: Follow the [Godot Android export setup](https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html) to configure your Android SDK and Java SDK paths in Godot's Editor Settings.
30+
31+
2. **Download Export Templates**: Make sure export templates are downloaded for your Godot version. Go to `Project -> Export...` and download templates if needed.
32+
33+
### Install Gradle Build Template
34+
35+
Go to `Project -> Install Android Build Template...` in the Godot editor and click "Install" in the confirmation dialog. This creates a Gradle-based Android project under `res://android/build/` in your project directory. The Sentry SDK will automatically integrate with this Gradle project.
36+
37+
### Configure Android Export
38+
39+
1. **Create Export Preset**: Go to `Project -> Export...` and add a new Android export preset.
40+
2. **Enable Gradle Build**: In the export preset, go to `Options -> Gradle Build` and enable the `Use Gradle Build` option.
41+
3. **Configure Other Settings**: Set up your package name, icons, permissions, and other Android-specific settings as needed.
42+
43+
![Android Export Settings](img/android_export.png)
44+
45+
### Export Your Project
46+
47+
When you export your project (or use one-click deploy), Godot will:
48+
- Call the Gradle build system to generate fresh templates.
49+
- The Sentry SDK automatically adds its dependencies to the Gradle configuration.
50+
- Build your APK/AAB with Sentry integration included.
51+
52+
## Known Limitations
53+
54+
While the Android support is comprehensive, there are some current limitations:
55+
56+
- Automatic screenshots on crashes are not yet supported on Android.
57+
- Local variable values in GDScript stack traces are not currently captured.
58+
59+
These limitations will be addressed in future versions of the SDK.

0 commit comments

Comments
 (0)