|
| 1 | +--- |
| 2 | +title: Configuring export for Android |
| 3 | +description: "Learn how the Godot SDK handles Android support." |
| 4 | +sidebar_order: 100 |
| 5 | +--- |
| 6 | + |
| 7 | +Additional steps are required to be able to export for Android with Sentry integration. |
| 8 | + |
| 9 | +## Setting up export for Android |
| 10 | + |
| 11 | +If you haven't exported for Android before, follow the [Godot Android export guide](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. |
| 12 | + |
| 13 | +## Step 1: Install Gradle Build Template |
| 14 | + |
| 15 | +Exporting for Android requires using Godot's Gradle build system. By default, Godot doesn't use Gradle build, so it needs to be enabled. |
| 16 | + |
| 17 | +If you haven't already, you need to install the Android build template first. 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. |
| 18 | + |
| 19 | +## Step 2: Configure Android Export |
| 20 | + |
| 21 | +1. **Create Export Preset**: If you don't have an export preset, you need to create one: go to `Project -> Export...` and add a new Android export preset. |
| 22 | +2. **Enable Gradle Build**: In the export preset, go to `Options -> Gradle Build` and enable the `Use Gradle Build` option. |
| 23 | +3. **Configure Other Settings**: Set up your package name, icons, permissions, and other Android-specific settings as needed. |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +## Step 3: Export Your Project |
| 28 | + |
| 29 | +Once configured, export your project normally. During export, Godot will automatically: |
| 30 | +- Generate fresh templates using the Gradle build system |
| 31 | +- Include Sentry SDK dependencies in the Gradle configuration |
| 32 | +- Build your APK/AAB with Sentry integration |
| 33 | + |
| 34 | +## Known Limitations |
| 35 | + |
| 36 | +While the Android support is comprehensive, there are some current limitations: |
| 37 | + |
| 38 | +- Automatic screenshots on crashes are not yet supported on Android. |
| 39 | +- Local variable values in GDScript stack traces are not currently captured. |
| 40 | + |
| 41 | +These limitations will be addressed in future versions of the SDK. |
0 commit comments