Configuration avancée du SDK Android

L'Unreal Engine utilise le kit de développement logiciel (SDK) Android fourni avec Android Studio pour tous les composants de développement essentiels Android, y compris le kit de développement natif (NDK) Android. Dans cette page, nous vous expliquons en détail comment configurer Android Studio et vous assurer que l'Unreal Engine reconnaît correctement ces composants ; nous vous fournissons également des conseils de dépannage pour gérer les installations NDK et les versions antérieures du moteur.

Configuration recommandée

Assurez-vous que l'Unreal Editor et le lanceur Epic Games sont tous deux fermés afin d'éviter tout problème lié à l'installation des composants NDK ou à la configuration des variables d'environnement du moteur.

Si vous devez prendre en charge une version précédente de l'Unreal Engine, consultez la rubrique Créer manuellement des chemins d'accès cibles aux SDK. Vous pouvez identifier la version du NDK correspondante à votre version de l'Unreal Engine sur la page Configuration minimale requise pour le développement sous Android.

Installer Android Studio

Avant de configurer les composants SDK et NDK nécessaires sur votre ordinateur, vous devez installer Android Studio.

1. Accédez à l'archive Android Studio dans votre navigateur Internet. Faites défiler l'écran vers le bas jusqu'à la section Android Studio Flamingo | 2022.2.1 Patch 2 May 24, 2023. Développez le menu déroulant et téléchargez le programme d'installation ou le fichier .zip correspondant à votre système d'exploitation.

   

2. Exécutez le programme d'installation d'Android Studio. Dans la fenêtre de configuration d'Android Studio, cliquez sur Next (Suivant) pour continuer.

3. Dans la boîte de dialogue Choose Components (Choisir les composants), laissez les composants par défaut activés. Cliquez sur Next (Suivant) pour continuer.

4. Dans la boîte de dialogue Install Locations (Emplacements d'installation), assurez-vous que l'emplacement d'installation est défini sur la valeur par défaut. Cliquez sur Next (Suivant) pour continuer.

   Si vous choisissez un emplacement d'installation personnalisé, le script SetupAndroid ne trouvera pas les fichiers, à moins que vous ne le modifiiez au préalable. Nous vous recommandons vivement de conserver l'emplacement d'installation par défaut.

5. Dans la boîte de dialogue Choose Start Menu Folder (Choisir le dossier du menu Démarrer), cliquez sur Install (Installer) pour lancer le processus d'installation.

6. Au terme de l'installation, cliquez sur Next (Suivant) pour configurer les composants.

7. Une fois la configuration terminée, assurez-vous que la case Start Android Studio (Démarrer Android Studio) est cochée et cliquez sur Finish (Terminer) pour quitter le programme d'installation.

Configurer Android Studio pour la première utilisation

Lorsque vous lancez Android Studio pour la première fois, procédez comme suit :

1. Lorsque la boîte de dialogue Data Sharing (Partage de données) s'affiche, indiquez si vous souhaitez envoyer les statistiques d'utilisation à Google. Sélectionnez l'option souhaitée. Quel que soit votre choix, vous passez à l'étape suivante.

2. Dans la boîte de dialogue Welcome to Android Studio (Bienvenue dans Android Studio), cliquez sur le menu déroulant More Actions (Autres actions), puis sur SDK Manager (Gestionnaire de SDK).

   

3. Dans les paramètres système du SDK Android, cliquez sur le bouton Edit (Modifier) en regard de Android SDK Location (Emplacement du SDK Android).

   

4. Dans la boîte de dialogue SDK Components Setup (Configuration des composants SDK), les composants nécessaires sont déjà sélectionnés. Cliquez sur Next (Suivant) pour les installer.

   

5. Dans la fenêtre Verify Settings (Vérifier les paramètres), cliquez de nouveau sur Next (Suivant) pour poursuivre l'installation.

6. Au terme de l'installation, cliquez sur Finish (Terminer).

7. Dans le menu Settings (Paramètres), cliquez sur l'onglet SDK Tools (Outils SDK). Une liste des composants facultatifs s'affiche.

8. Cochez la case Show Package Details (Afficher les détails du paquet) pour afficher tous les composants SDK disponibles.

9. Cochez la case Android SDK Command-line Tools (latest) (Outils de ligne de commande du SDK Android (dernière version)). Cliquez sur Apply (Appliquer) pour télécharger et installer ce composant.

   

10. Cliquez sur OK pour fermer la fenêtre et la boîte de dialogue de bienvenue.

Finaliser l'installation d'Android Studio sur votre système d'exploitation

Après avoir suivi toutes ces étapes, vous devez finaliser votre installation pour vous assurer que votre environnement est complètement configuré avant de continuer. L'étape nécessaire pour finaliser l'installation est différente sur chaque système d'exploitation.

Réinitialiser ou vérifier vos variables d'environnement

Les étapes de cette section s'adressent principalement aux utilisateurs qui passent de l'UE 5.2 et versions antérieures à l'UE 5.3 et versions ultérieures, et qui peuvent avoir besoin de réinitialiser leurs variables d'environnement. Si vous travaillez avec une nouvelle installation de l'UE et d'Android Studio, passez à la section suivante.

Cette remarque est particulièrement importante pour les utilisateurs qui ont utilisé AGDE pour le débogage, car l'UE et AGDE ciblent désormais le répertoire JBR et n'ont pas besoin de variables d'environnement distinctes.

1. Ouvrez les propriétés système de votre ordinateur.

2. Cliquez sur le bouton Variables d'environnement.

3. Si vous disposez d'une variable d'environnement appelée AGDE_JAVA_HOME, supprimez-la. Cette variable n'est plus nécessaire, car l'Unreal Engine et AGDE utilisent désormais la même version Java.

4. Réinitialisez ou vérifiez les variables d'environnement suivantes.

   Variable d'environnement	Valeur attendue
   JAVA_HOME	C:\Program Files\Android\Android Studio\jbr
   ANDROID_HOME	C:\Users(nom d'utilisateur)\AppData\Local\Android\Sdk
   NDK_ROOT	C:\Users(nom d'utilisateur)\AppData\Local\Android\Sdk\ndk(numéro de version du NDK)
   NDKROOT	C:\Users(nom d'utilisateur)\AppData\Local\Android\Sdk\ndk(numéro de version du NDK)

   Remplacez (nom d'utilisateur) par votre nom d'utilisateur et (numéro de version du NDK) par le nom du répertoire correspondant au numéro de version requis pour votre installation.

   Une solution rapide consiste à supprimer vos variables d'environnement. Celles-ci seront remplacées par le script SetupAndroid lors d'une étape ultérieure.

Si vous devez prendre en charge une version antérieure de l'Unreal Engine, nous vous recommandons de suivre la procédure ci-dessus pour maintenir la compatibilité avec les versions actuelles et futures de l'Unreal Engine. Pour préserver les chemins de vos versions précédentes de l'Unreal Engine, nous vous recommandons de modifier les paramètres du projet et de cibler manuellement les chemins SDK de leurs versions des SDK, NDK et JDK Android. Pour en savoir plus, consultez la rubrique Créer manuellement des chemins d'accès cibles aux SDK.

Exécuter le script SetupAndroid

Une fois les composants SDK Android nécessaires installés, vous pouvez utiliser le script SetupAndroid pour télécharger et installer la version correcte du NDK Android.

1. Ouvrez le répertoire Engine/Extras/Android et exécutez le script SetupAndroid correspondant à votre système d'exploitation :

   • SetupAndroid.bat – Windows

   • SetupAndroid.command – Mac

   • SetupAndroid.sh – Linux.

2. Le script vous invite à accepter le contrat de licence du SDK Android. Saisissez Y et appuyez sur la touche Entrée pour accepter.

3. Une fois l'installation terminée, appuyez sur une touche pour masquer l'invite de commande.

4. Redémarrez votre ordinateur pour que toutes les modifications soient prises en compte.

Le répertoire d'installation du NDK doit être le suivant : C:/Users/[nom d'utilisateur]/AppData/Local/Android/SDK/ndk/, où [nom d'utilisateur] correspond au nom de connexion de votre ordinateur. Un dossier contenant la version du NDK requise doit être présent à cet emplacement.

Créer manuellement des chemins d'accès cibles aux SDK

Si vous avez suivi les instructions ci-dessus sans rencontrer de problèmes, l'Unreal Engine associe automatiquement les chemins d'accès aux SDK pour le SDK Android, la version actuelle du NDK Android et le kit de développement Java (JDK). Toutefois, si vous utilisez une version antérieure de l'Unreal Engine avec Android Studio, il est possible que vous deviez cibler manuellement vos chemins d'accès aux SDK pour assurer la compatibilité. Vous devrez probablement procéder à une migration de l'UE 5.0, 5.1 ou 5.2 vers l'UE 5.3 ou une version ultérieure.

Pour identifier les chemins d'accès aux SDK, accédez à Modifier > Paramètres du projet, puis accédez à la section Plateformes > Android > SDK Android.

Si ces champs sont vides, l'UE a recours à un ensemble de chemins d'accès par défaut utilisés par le processus d'installation dans les sections précédentes. Si vous avez installé plusieurs de ces composants ou que vous les avez installés dans des répertoires non standard, vous pouvez indiquer manuellement leurs chemins d'accès ici. Sinon, vous pouvez ouvrir BaseEngine.ini et les spécifier dans la section [/Script/AndroidPlatformEditor.AndroidSDKSettings].

[/Script/AndroidPlatformEditor.AndroidSDKSettings]
    SDKPath = (Path="C:\Filepath")
    NDKPath = (Path="C:\Filepath")
    JDKPath = (Path="C:\Filepath")

Si les entrées SDKPath, NDKPath et JDKPath n'existent pas dans votre fichier BaseEngine.ini, elles utilisent le chemin d'accès par défaut au répertoire d'origine Android.