Configurer Android Single Instance Service

Dans ce guide, nous vous expliquons comment configurer le service Android Single Instance Service (ASIS) dans l'Unreal Engine, puis comment créer, empaqueter et exécuter votre projet Unreal Engine en tant qu'application Android.

Configurer les SDK et NDK Android

Pour configurer ASIS, vous devez d'abord configurer le kit de développement logiciel (SDK) Android et le kit de développement natif (NDK) Android dans l'Unreal Engine. Unreal Engine utilise Android Studio et les outils de ligne de commande du SDK Android pour télécharger et installer les composants SDK Android nécessaires au développement de projets Android.

Pour configurer les SDK et NDK Android, procédez comme suit :

1. Suivez les étapes de la page Setting Up Android SDK and NDK (Configurer les SDK et NDK Android).  

2. Si vous utilisez l'Unreal Engine version 5.5 ou ultérieure, activez les plateformes SDK et outils suivants :

   1. Outils SDK > Android SDK Build-Tools 36 > 35.0.0 et 34.0.0

      

   2. Outils SDK > NDK (Side by side) > 25.1.8937393

      

   3. Plateformes SDK > Android 14.0 ("UpsideDownCake"), API Level 34

      

Créer un nouveau projet à partir du modèle ASIS  

Une fois les SDK et NDK Android installés, vous pouvez configurer le plug-in du modèle ASIS. Le plug-in est fourni dans un fichier d'archive distinct. Des étapes manuelles doivent donc être effectuées pour préparer le code source de l'Unreal Engine.

Obtenir le code source de l'Unreal Engine

Récupérez la dernière version du code source depuis la branche principale de l'UE5 via Perforce ou Github. Pour plus d'informations sur l'utilisation de Perforce et Github avec l'Unreal Engine, consultez les ressources suivantes :

• Utiliser Perforce comme contrôle de source

• Comment utiliser l'Unreal Engine 5 - Perforce

• Accéder au code source de l'Unreal Engine sur GitHub

• Télécharger le code source de l'Unreal Engine

• Générer l'Unreal Engine à partir du code source

Configurer le plug-in ASIS

1. Accédez au dossier ASIS Templates.

1. Accédez au dossier ASIS Templates.

   1. Si vous utilisez Perforce, accédez à UE5_Main\Engine\Restricted\NotForLicensees\Plugins\AndroidSingleInstanceService\Templates\.

   2. Si vous utilisez GitHub, accédez à la branche ue5-main, puis à ue5-main\Engine\Restricted\NotForLicensees\plug-ins\AndroidSingleInstanceService. 

2. Copiez le dossier TP_HMI_ASIS sous UE5_Main\Templates\ (Perforce) ou ue5-main\Templates\ (GitHub).

3. Copiez le code suivant et collez-le sous UE5_Main\Templates\TemplateCategories.ini (Perforce) ou ue5-main\Templates\TemplateCategories.ini (GitHub) :

   C++

   Categories=(Key="HMI", LocalizedDisplayNames=((Language="en",Text="Automotive\nHMI &\nVehicle Cockpit using Android Single Instance Service")), LocalizedDescriptions=((Language="en",Text="Find templates for automotive vehicle cockpit using Android Single Instance Service"), Icon="TP_HMI_ASIS/Media/AutomotiveHMI_2x.png", IsMajorCategory=true)

   Copy full snippet(1 line long)

4. Exécutez UnrealEditor. Le navigateur de projets de l'Unreal doit maintenant inclure un nouveau modèle IHM (interface homme-machine) :

   

5. Cliquez sur Créer. Le projet doit ressembler à la capture d'écran suivante :

   

Ajouter le plug-in ASIS à un projet existant

Ajouter le plug-in ASIS à un projet existant

Si vous voulez ajouter ASIS à un projet existant, procédez comme suit :

1.  Accédez à Modifier > Plug-ins et activez AndroidSingleInstanceService.

   

2. Copiez le code suivant et collez-le dans le fichier {Project_Name}/Config/DefaultGame.ini :

   Config

   [Staging]
   +RemapDirectories=(From="Engine/Restricted/NotForLicensees/Plugins/AndroidSingleInstanceService", To="Engine/Plugins/Runtime/AndroidSingleInstanceService")
   +RemapDirectories=(From="Engine/Restricted/NotForLicensees/Plugins/Experimental/MultiWindow", To="Engine/Plugins/Experimental/MultiWindow")

   Copy full snippet(3 lines long)

3. Dans l'Unreal Engine, accédez à Modifier> Paramètres du projet.

4. Sous Plug-ins > AndroidSingleInstanceService, activez les paramètres suivants :

   

   1. Compile ASICProject

   2. Enable asis libs generation

   3. Use AndroidSingleInstanceService

Empaqueter et lancer le projet ASIS

Après avoir configuré ASIS dans votre projet Unreal Engine, vous pouvez empaqueter et exécuter le projet en tant qu'application Android.

Pour empaqueter le projet ASIS en tant qu'application Android, procédez comme suit :

1. Dans la barre d'outils principale, cliquez sur Plateformes > Android > Empaqueter le projet.

   

2. Consultez le journal de sortie pour vérifier que la compilation a réussi.

   

Le paquet est enregistré par défaut sous /Documents/UnrealProjects/_packages/ASIS_Package.

Communiquer entre l'application Android et l'APK Unreal Engine

Après avoir empaqueté l'application, vous pouvez utiliser un exemple d'application cliente pour communiquer avec l'APK Unreal Engine.

Le paquet Unreal Engine comprend trois parties principales :

• Un APK avec Android Service. Il figure dans le dossier que vous avez sélectionné dans la boîte de dialogue Empaqueter le projet.

• Un ensemble de bibliothèques d'aide ASIS utilisées dans les applications clientes.

  C++

  Binaries/Android/aars
  ├── asisclientlib-1.0.1-debug.aar
  ├── asisclientlib-1.0.1-debug.jar
  ├── asiscommon-1.0.1-debug.aar
  └── asiscommon-1.0.1-debug.jar

  Copy full snippet(5 lines long)

• Un exemple d'application cliente qui communique avec le service. Il n'est pas situé dans le projet Unreal Engine empaqueté, mais sous le dossier Binaries de votre Projet Unreal Engine (\Unreal Projects\{Project_Name}\Binaries\Android).

  

Vous pouvez utiliser Android Studio pour ouvrir l'exemple de projet Android. Le processus de compilation Android sera automatiquement lancé lors de son ouverture. 

Vous pouvez également créer le projet à l'aide de l'invite de commande suivante :

cd {Project_Name}\Binaries\Android\ExampleUseCase_{Project_Name}\
gradlew assembleDebug

Cette commande génère un fichier APK sous {Project_Name}\Binaries\ Android\ExampleUseCase_{Project_Name}\app\ version\outputs\apk\debug\app-debug.apk.

Après avoir sélectionné un appareil Android dans Android Studio, vous pouvez exécuter l'application en appuyant sur Maj + F10 ou en cliquant sur le bouton Play dans la barre d'outils supérieure.

Pour installer l'APK sur votre appareil Android, exécutez la commande adb suivante :

adb install {Project_Name}.apk

Accédez à l'application depuis votre appareil, cliquez sur Activate View1, Activate View2 et Activate View3 pour vérifier la communication entre le service Android et l'application Unreal Engine.