Ajouter Firebase à votre projet Unity

Améliorez vos jeux Unity avec nos SDK Unity Firebase.

Pour vous montrer à quel point il est facile d'intégrer Firebase à votre projet Unity, nous avons créé un exemple de jeu, MechaHamster. Si vous souhaitez essayer d'ajouter Firebase à un jeu, utilisez la version de démarrage disponible sur GitHub. Si vous souhaitez une version terminée, consultez les versions disponibles sur l'App Store ou sur Google Play Store.

MechaHamster (GitHub)

MechaHamster (App Store)

MechaHamster (Play Store)


Pour en savoir plus sur l'optimisation de vos jeux avec Firebase, consultez la page des jeux Firebase.

Avez-vous déjà ajouté Firebase à votre projet Unity ? Assurez-vous d'utiliser la dernière version du SDK Unity Firebase.

Prérequis

  • Installez Unity 2021 LTS ou une version ultérieure. La prise en charge d'Unity 2020 est considérée comme obsolète et ne sera plus activement prise en charge après la prochaine version majeure. Les versions antérieures peuvent également être compatibles, mais elles ne seront pas activement prises en charge.

  • (Plates-formes Apple uniquement) Installez les éléments suivants:

    • Xcode 13.3.1 ou version ultérieure
    • CocoaPods 1.12.0 ou version ultérieure

  • Assurez-vous que votre projet Unity répond aux exigences suivantes:

    • Pour iOS : cible iOS 13 ou version ultérieure
    • Pour tvOS : cible tvOS 13 ou version ultérieure
    • Pour Android : cible le niveau d'API 21 (Lollipop) ou version ultérieure

  • Configurez un appareil physique ou utilisez un émulateur pour exécuter votre application.

    • Pour les plates-formes Apple : configurez un appareil physique ou utilisez un simulateur iOS ou tvOS.

    • Pour Android : les émulateurs doivent utiliser une image d'émulateur avec Google Play.

Si vous ne disposez pas encore d'un projet Unity et que vous souhaitez simplement essayer un produit Firebase, vous pouvez télécharger l'un de nos exemples de démarrage rapide.

Étape 1: Créez un projet Firebase

Avant de pouvoir ajouter Firebase à votre projet Unity, vous devez créer un projet Firebase pour vous connecter à votre projet Unity. Consultez Comprendre les projets Firebase pour en savoir plus sur les projets Firebase.

Étape 2: Enregistrer votre application auprès de Firebase

Vous pouvez enregistrer une ou plusieurs applications ou jeux pour les connecter à votre projet Firebase.

  1. Accédez à la console Firebase.

  2. Au centre de la page de présentation du projet, cliquez sur l'icône Unity () pour lancer le workflow de configuration.

    Si vous avez déjà ajouté une application à votre projet Firebase, cliquez sur Ajouter une application pour afficher les options de plate-forme.

  3. Sélectionnez la cible de compilation de votre projet Unity que vous souhaitez enregistrer, ou vous pouvez même enregistrer les deux cibles en même temps.

  4. Saisissez le ou les ID spécifiques à la plate-forme de votre projet Unity.

    • Pour iOS : saisissez l'ID iOS de votre projet Unity dans le champ ID de bundle iOS.

    • Pour Android : saisissez l'ID Android de votre projet Unity dans le champ Nom du package Android.
      Les termes nom du package et ID de l'application sont souvent utilisés de manière interchangeable.

  5. (Facultatif) Entrez le ou les surnoms spécifiques à la plate-forme de votre projet Unity.
    Ces surnoms sont des identifiants internes et pratiques. Vous ne les voyez que dans la console Firebase.

  6. Cliquez sur Enregistrer l'application.

Étape 3: Ajouter des fichiers de configuration Firebase

  1. Obtenez le ou les fichiers de configuration Firebase spécifiques à la plate-forme dans le workflow de configuration de la console Firebase.

    • Pour iOS : cliquez sur Télécharger GoogleService-Info.plist.

    • Pour Android : cliquez sur Télécharger google-services.json.

  2. Ouvrez la fenêtre Project(Projet) de votre projet Unity, puis déplacez vos fichiers de configuration dans le dossier Assets.

  3. De retour dans la console Firebase, dans le workflow de configuration, cliquez sur Suivant.

Étape 4: Ajouter les SDK Unity Firebase

  1. Dans la console Firebase, cliquez sur Télécharger le SDK Unity Firebase, puis décompressez le SDK dans un emplacement pratique.

    • Vous pouvez à tout moment télécharger à nouveau le SDK Unity Firebase.

    • Le SDK Unity Firebase n'est pas spécifique à une plate-forme.

  2. Dans votre projet Unity ouvert, accédez à Assets (Éléments) > Import Package (Importer un package) > Custom Package (Package personnalisé).

  3. Dans le SDK décompressé, sélectionnez les produits Firebase compatibles que vous souhaitez utiliser dans votre application.

    Analytics activé

    • Ajoutez le package Firebase pour Google Analytics : FirebaseAnalytics.unitypackage
    • Ajoutez les packages pour tous les autres produits Firebase que vous souhaitez utiliser dans votre application. Par exemple, pour utiliser Firebase Authentication et Firebase Realtime Database:
      FirebaseAuth.unitypackage et FirebaseDatabase.unitypackage

    Analytics non activé

    Ajoutez les packages des produits Firebase que vous souhaitez utiliser dans votre application. Par exemple, pour utiliser Firebase Authentication et Firebase Realtime Database:
    FirebaseAuth.unitypackage et FirebaseDatabase.unitypackage

  4. Dans la fenêtre Import Unity Package (Importer un package Unity) qui s'ouvre, cliquez sur Import (Importer).

  5. De retour dans la console Firebase, dans le workflow de configuration, cliquez sur Suivant.

Étape 5: Vérifier les exigences concernant la version des services Google Play

Le SDK Unity Firebase pour Android nécessite Google Play services, qui doit être à jour avant que le SDK puisse être utilisé.

Ajoutez l'instruction using et le code d'initialisation suivants au début de votre application. Vous pouvez vérifier si Google Play services est disponible et éventuellement le mettre à jour vers la version requise par le SDK Unity Firebase avant d'appeler d'autres méthodes du SDK.

using Firebase.Extensions;

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWithOnMainThread(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp,
    // where app is a Firebase.FirebaseApp property of your application class.
       app = Firebase.FirebaseApp.DefaultInstance;

    // Set a flag here to indicate whether Firebase is ready to use by your app.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

Vous avez terminé ! Votre projet Unity est enregistré et configuré pour utiliser Firebase.

Toutefois, si vous rencontrez des difficultés pour configurer Unity, consultez les questions fréquentes et le dépannage pour Unity.

Configurer un workflow pour ordinateur (bêta)

Lorsque vous créez un jeu, il est souvent beaucoup plus facile de le tester d'abord dans l'éditeur Unity et sur les plates-formes de bureau, puis de le déployer et de le tester sur des appareils mobiles plus tard dans le développement. Pour prendre en charge ce workflow, nous fournissons un sous-ensemble des SDK Unity Firebase pouvant s'exécuter sous Windows, macOS, Linux et depuis l'éditeur Unity.

  1. Configurez un projet Unity pour une plate-forme de bureau en suivant les mêmes instructions que pour une plate-forme mobile (commencez par l'étape Enregistrer votre application auprès de Firebase ci-dessus).

  2. Exécutez votre projet Unity dans l'IDE Unity ou sélectionnez la compilation de votre projet Unity pour ordinateur.

  3. (Facultatif) Exécutez votre projet Unity en mode Édition.

    Le SDK Unity Firebase peut également être exécuté en mode édition d'Unity, ce qui permet de l'utiliser dans les plug-ins d'éditeur.

    1. Lorsque vous créez un FirebaseApp utilisé par l'éditeur, n'utilisez pas l'instance par défaut.

    2. Attribuez plutôt un nom unique à l'appel FirebaseApp.Create().

      Cela est important pour éviter tout conflit d'options entre l'instance utilisée par l'IDE Unity et l'instance utilisée par votre projet Unity.

Produits Firebase compatibles

Pour en savoir plus sur les bibliothèques Firebase Unity, consultez la documentation de référence.

Bibliothèques Firebase disponibles pour les mobiles

Le SDK Unity Firebase est compatible avec les produits Firebase suivants sur Apple et Android:

Produit Firebase Package Unity
AdMob Distribué séparément dans le plug-in Unity AdMob
Analytics FirebaseAnalytics.unitypackage
App Check FirebaseAppCheck.unitypackage
Authentication FirebaseAuth.unitypackage
Cloud Firestore FirebaseFirestore.unitypackage
Cloud Functions FirebaseFunctions.unitypackage
Cloud Messaging FirebaseMessaging.unitypackage
(recommandé) FirebaseAnalytics.unitypackage
Cloud Storage FirebaseStorage.unitypackage
Crashlytics FirebaseCrashlytics.unitypackage
(recommandé) FirebaseAnalytics.unitypackage
Dynamic Links FirebaseDynamicLinks.unitypackage
(recommandé) FirebaseAnalytics.unitypackage
Realtime Database FirebaseDatabase.unitypackage
Remote Config FirebaseRemoteConfig.unitypackage
(recommandé) FirebaseAnalytics.unitypackage

Bibliothèques Firebase disponibles pour ordinateur

Le SDK Unity Firebase inclut la prise en charge des workflows sur ordinateur pour un sous-ensemble de produits, ce qui permet d'utiliser certaines parties de Firebase dans l'éditeur Unity et dans les builds autonomes pour ordinateur sous Windows, macOS et Linux.

Produit Firebase (ordinateur) Package Unity
App Check FirebaseAppCheck.unitypackage
Authentication FirebaseAuth.unitypackage
Cloud Functions FirebaseFunctions.unitypackage
Cloud Firestore FirebaseFirestore.unitypackage
Cloud Storage FirebaseStorage.unitypackage
Realtime Database FirebaseDatabase.unitypackage
Remote Config FirebaseRemoteConfig.unitypackage

Firebase fournit les autres bibliothèques pour ordinateur de bureau en tant qu'implémentations de bouchon (non fonctionnelles) pour plus de commodité lors de la compilation pour Windows, macOS et Linux. Par conséquent, vous n'avez pas besoin de compiler le code de manière conditionnelle pour cibler le bureau.

Étapes suivantes