Merge pull request #11733 from m4gr3d/update_android_studio_instructions

Update the Android Studio instructions to match the new build types

Author: mhilbrunner

engine_details/development/compiling/compiling_for_android.rst

@@ -30,7 +30,7 @@ For compiling under Windows, Linux or macOS, the following is required:
 - `SCons 4.0+ <https://scons.org/pages/download.html>`_ build system.
 - Android SDK
 
-   - To install the Android SDK, follow the steps here <https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html>_.
+   - To install the Android SDK, follow the steps `here <https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html>`_.
    - On Linux, **do not use an Android SDK provided by your distribution's repositories** as it will often be outdated.
    - On macOS, **do not use an Android SDK provided by Homebrew** as it will not be installed in a unified location.
 
@@ -97,24 +97,18 @@ root directory with the following arguments:
     scons platform=android target=template_debug arch=arm32
     scons platform=android target=template_debug arch=arm64 generate_android_binaries=yes
 
-- (**Optional**) Dev template (used when troubleshooting)
-
-::
-
-    scons platform=android target=template_debug arch=arm32 dev_build=yes
-    scons platform=android target=template_debug arch=arm64 dev_build=yes generate_android_binaries=yes
-
 The resulting templates will be located under the ``bin`` directory:
 
 - ``bin/android_release.apk`` for the release template
 - ``bin/android_debug.apk`` for the debug template
-- ``bin/android_dev.apk`` for the dev template
 - ``bin/android_source.zip`` for the Gradle build template
 
 .. note::
 
    - If you are changing the list of architectures you're building, remember to add ``generate_android_binaries=yes`` to the *last* architecture you're building, so that the template files are generated after the build.
 
+   - To enable dev build (for use when troubleshooting) in the generated templates, add the ``dev_build=yes`` parameters to the SCons command.
+
    - To include debug symbols in the generated templates, add the ``debug_symbols=yes`` parameters to the SCons command.
 
        - Note that you can include ``separate_debug_symbols=yes`` to generate the debug symbols in a separate ``*-native-debug-symbols.zip`` file.

engine_details/development/configuring_an_ide/android_studio.rst

@@ -28,43 +28,46 @@ Android Studio project layout
 
 The project is organized using `Android Studio's modules <https://developer.android.com/studio/projects#ApplicationModules>`_:
 
-- ``lib`` module:
-   - Located under ``<Godot root directory>/platform/android/java/lib``, this is a **library module** that organizes
-      the Godot java and native code and make it available as a reusable dependency / artifact.
-   - The artifact generated by this module is made available for other Android modules / projects to use as a dependency, via `MavenCentral <https://repo1.maven.org/maven2/org/godotengine/godot/>`_.
+- **lib** module:
 
-- ``editor`` module:
-   - Located under ``<Godot root directory>/platform/android/java/editor``, this is an **application module** that holds
-      the source code for the Android port of the Godot Editor.
-   - This module has a dependency on the ``lib`` module.
+   - Located under ``<Godot root directory>/platform/android/java/lib``, this is a **library module** that organizes the Godot java and native code and make it available as a reusable `Android library <https://developer.android.com/studio/projects/android-library>`_.
+   - The generated :ref:`Godot Android library <doc_android_library>` is made available for other Android modules / projects via `MavenCentral <https://central.sonatype.com/artifact/org.godotengine/godot>`_, along with `its documentation <https://javadoc.io/doc/org.godotengine/godot/latest/index.html>`_.
 
-- ``app`` module:
-   - Located under ``<Godot root directory>/platform/android/java/app``, this is an **application module** that holds
-      the source code for the Android build templates.
-   - This module has a dependency on the ``lib`` module.
+- **editor** module:
+
+   - Located under ``<Godot root directory>/platform/android/java/editor``, this is an **application module** that holds the source code for the `Android and XR ports <https://godotengine.org/download/android/>`_ of the Godot Editor.
+   - This module has a dependency on the **lib** module.
+
+- **app** module:
+
+   - Located under ``<Godot root directory>/platform/android/java/app``, this is an **application module** that holds the source code for the Android build templates.
+   - This module has a dependency on the **lib** module.
 
 Building & debugging the editor module
 --------------------------------------
 
 - To build the ``editor`` module:
+
    - Select the `Run/Debug Configurations drop down <https://developer.android.com/studio/run/rundebugconfig#running>`_ and select ``editor``.
 
    .. figure:: img/android_studio_editor_configurations_drop_down.webp
       :figclass: figure-w480
       :align: center
 
    - Select **Run > Run 'editor'** from the top menu or `click the Run icon <https://developer.android.com/studio/run/rundebugconfig#running>`_.
+
 - To debug the ``editor`` module:
+
    - Open the **Build Variants** window using **View > Tools Windows > Build Variants** from the top menu.
-   - In the **Build Variants** window, make sure that in the **Active Build Variant** column, the ``:editor`` entry is set to one of the **Dev** variants.
+   - In the **Build Variants** window, make sure that in the **Active Build Variant** column, the ``:editor`` entry is set to one of the **Debug** variants.
 
    .. figure:: img/android_studio_editor_build_variant.webp
       :figclass: figure-w480
       :align: center
 
    - Open the **Run/Debug Configurations** window by clicking on **Run > Edit Configurations...** on the top menu.
    - In the **Run/Debug Configurations** window, select the ``editor`` entry, and under **Debugger** make sure the **Debug Type** is set to ``Dual (Java + Native)``
-   - Click the ``+`` sign under the **Symbol Directories** section, and add the ``lib`` module directory: ``platform/android/java/lib``
+   - Click the ``+`` sign under the **Symbol Directories** section, and add the ``platform/android/java/lib/libs/tools/debug`` directory.
 
    .. figure:: img/android_studio_editor_debug_type_setup.webp
       :figclass: figure-w480
@@ -81,24 +84,27 @@ While developing in Android Studio, it's necessary to manually add a Godot proje
 Once that's done, you can follow the instructions below to run/debug the ``app`` module:
 
 - To build the ``app`` module:
+
    - Select the `Run/Debug Configurations drop down <https://developer.android.com/studio/run/rundebugconfig#running>`_ and select ``app``.
 
    .. figure:: img/android_studio_app_configurations_drop_down.webp
       :figclass: figure-w480
       :align: center
 
    - Select **Run > Run 'app'** from the top menu or `click the Run icon <https://developer.android.com/studio/run/rundebugconfig#running>`_.
+
 - To debug the ``app`` module:
+
    - Open the **Build Variants** window using **View > Tools Windows > Build Variants** from the top menu.
-   - In the **Build Variants** window, make sure that in the **Active Build Variant** column, the ``:app`` entry is set to one of the **Dev** variants.
+   - In the **Build Variants** window, make sure that in the **Active Build Variant** column, the ``:app`` entry is set to one of the **Debug** variants.
 
    .. figure:: img/android_studio_app_build_variant.webp
       :figclass: figure-w480
       :align: center
 
    - Open the **Run/Debug Configurations** window by clicking on **Run > Edit Configurations...** on the top menu.
    - In the **Run/Debug Configurations** window, select the ``app`` entry, and under **Debugger** make sure the **Debug Type** is set to ``Dual (Java + Native)``
-   - Click the ``+`` sign under the **Symbol Directories** section, and add the ``lib`` module directory: ``platform/android/java/lib``
+   - Click the ``+`` sign under the **Symbol Directories** section, and add the ``platform/android/java/lib/libs/debug`` directory.
 
    .. figure:: img/android_studio_app_debug_type_setup.webp
       :figclass: figure-w480