Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

適用於 Android 的 Gradle 建置

Godot provides the option to build using the Gradle build system. Instead of using the already pre-built template that ships with Godot, an Android Java project gets installed into your project folder. Godot will then build it and use it as an export template every time you export the project.

有幾個原因會需要這麼做:

  • Export an AAB file for Google Play.

  • 要在建置前修改專案。

  • 建置專案時要加上外部 SDK。

The native portion of the template (the .so library included in the APK) remains precompiled. This means that unlike compiling a custom Android export template, you don't need to install a C++ toolchain or clone the Godot source code.

Configuring the Gradle build is a fairly straightforward process. But first, you need to follow the steps in exporting for android up to Setting it up in Godot. After doing that, follow the steps below.

Set up the Gradle build environment

前往「專案」選單,並安裝 Gradle 建置 樣板:

../../_images/gradle_build_install_template.webp

請確定有下載匯出樣板。若沒下載的話,該選單會協助下載。

這會在 res://android/build 下建立一個 Gradle 為基礎的 Android 專案。除非你真的需要修改專案,否則不需要編輯這些檔案。

Performing Gradle builds from the Android editor

Since Godot 4.6, it is possible to perform Gradle builds from the Android editor. This requires installing the Godot Android Build Environment (GABE) application on the same device the editor is running on.

備註

This application is not required when exporting from the Android editor with pre-built APK templates, or when exporting to other platforms.

This application lets you install everything required to build Android projects with Gradle. It is called by the editor to perform Gradle builds when exporting to Android.

To set up the build environment, open the app and follow these instructions:

  • Ensure you have an active Internet connection.

  • Open the Rootfs tab from the bottom navigation bar.

  • Click Install Rootfs.

After the installation completes, you can export projects using Gradle builds from the Godot editor.

Enabling the Gradle build and exporting

在設定 Android 專案時,於 專案 > 匯出 對話框中,請啟用 Gradle 建置:

../../_images/gradle_build_enable.webp

From now on, attempting to export the project or one-click deploy will call the Gradle build system to generate fresh templates. The templates built will be used automatically afterwards, so no further configuration is needed.

備註

When using the Gradle Android build system, assets that are placed within a folder whose name begins with an underscore will not be included in the generated APK. This does not apply to assets whose file name begins with an underscore.

例如,_example/image.png 將**不會**包含為素材,但``_image.png`` 會。