Добавьте Firebase в свой проект Unity

Улучшите свои игры Unity с помощью наших SDK Firebase Unity .

Чтобы показать, насколько легко подключить Firebase к вашему проекту Unity, мы создали образец игры MechaHamster. Если вы хотите попробовать добавить Firebase в игру, используйте стартовую версию на GitHub . Если вам нужна завершенная версия, проверьте версии в App Store или Google Play Store .

МехаХамстер (GitHub)

MechaHamster (магазин приложений)

MechaHamster (Play Store)


Дополнительную информацию об улучшении ваших игр с помощью Firebase можно найти на нашей странице игр Firebase .

Уже добавили Firebase в свой проект Unity? Убедитесь, что вы используете последнюю версию Firebase Unity SDK .

Предварительные условия

  • Установите Unity 2021 LTS или более позднюю версию. Поддержка Unity 2020 считается устаревшей и больше не будет активно поддерживаться после следующего основного выпуска. Более ранние версии также могут быть совместимы, но не будут активно поддерживаться.

  • (Только для платформ Apple) Установите следующее:

    • Xcode 13.3.1 или выше
    • CocoaPods 1.12.0 или выше

  • Убедитесь, что ваш проект Unity соответствует этим требованиям:

    • Для iOS — ориентирован на iOS 13 или более позднюю версию.
    • Для tvOS — предназначена для tvOS 13 или более поздней версии.
    • Для Android — целевой уровень API 21 (Lollipop) или выше.

  • Настройте физическое устройство или используйте эмулятор для запуска приложения.

    • Для платформ Apple — настройте физическое устройство или используйте симулятор iOS или tvOS.

    • Для Android — эмуляторы должны использовать образ эмулятора из Google Play.

Если у вас еще нет проекта Unity и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .

Шаг 1. Создайте проект Firebase.

Прежде чем вы сможете добавить Firebase в свой проект Unity, вам необходимо создать проект Firebase для подключения к вашему проекту Unity. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.

Шаг 2. Зарегистрируйте свое приложение в Firebase.

Вы можете зарегистрировать одно или несколько приложений или игр для подключения к вашему проекту Firebase.

  1. Перейдите в консоль Firebase .

  2. В центре страницы обзора проекта щелкните значок Unity ( ), чтобы запустить рабочий процесс установки.

    Если вы уже добавили приложение в свой проект Firebase, нажмите «Добавить приложение», чтобы отобразить параметры платформы.

  3. Выберите, какую цель сборки вашего проекта Unity вы хотите зарегистрировать, или вы даже можете выбрать регистрацию обеих целей одновременно.

  4. Введите идентификаторы платформы вашего проекта Unity.

    • Для iOS — введите идентификатор iOS вашего проекта Unity в поле «Идентификатор пакета iOS» .

    • Для Android — введите идентификатор Android вашего проекта Unity в поле имени пакета Android .
      Термины «имя пакета» и «идентификатор приложения» часто используются как взаимозаменяемые.

  5. (Необязательно) Введите псевдонимы для конкретной платформы вашего проекта Unity.
    Эти псевдонимы являются внутренними удобными идентификаторами и видны только вам в консоли Firebase .

  6. Нажмите Зарегистрировать приложение .

Шаг 3. Добавьте файлы конфигурации Firebase.

  1. Получите файлы конфигурации Firebase для конкретной платформы в рабочем процессе настройки консоли Firebase .

    • Для iOS — нажмите «Загрузить GoogleService-Info.plist» .

    • Для Android — нажмите «Загрузить google-services.json» .

  2. Откройте окно «Проект» вашего проекта Unity, затем переместите файлы конфигурации в папку Assets ».

  3. Вернувшись в консоль Firebase , в рабочем процессе установки нажмите «Далее» .

Шаг 4. Добавьте SDK Firebase Unity

  1. В консоли Firebase нажмите «Загрузить Firebase Unity SDK» , затем разархивируйте SDK в удобное место.

    • Вы можете снова загрузить Firebase Unity SDK в любое время.

    • Firebase Unity SDK не зависит от платформы.

  2. В открытом проекте Unity перейдите в Assets > Import Package > Custom Package .

  3. В разархивированном SDK выберите поддерживаемые продукты Firebase , которые вы хотите использовать в своем приложении.

    Analytics включена

    • Добавьте пакет Firebase для Google Analytics : FirebaseAnalytics.unitypackage
    • Добавьте пакеты для любых других продуктов Firebase, которые вы хотите использовать в своем приложении. Например, чтобы использовать Firebase Authentication и Firebase Realtime Database :
      FirebaseAuth.unitypackage и FirebaseDatabase.unitypackage

    Analytics не включена

    Добавьте пакеты для продуктов Firebase, которые вы хотите использовать в своем приложении. Например, чтобы использовать Firebase Authentication и Firebase Realtime Database :
    FirebaseAuth.unitypackage и FirebaseDatabase.unitypackage

  4. В окне «Импорт пакета Unity» нажмите «Импорт» .

  5. Вернувшись в консоль Firebase , в рабочем процессе установки нажмите «Далее» .

Шаг 5. Подтвердите требования к версии сервисов Google Play.

Firebase Unity SDK для Android требует наличия Google Play services , которые должны быть обновлены, прежде чем SDK можно будет использовать.

Добавьте следующий оператор using и код инициализации в начале вашего приложения. Вы можете проверить и при необходимости обновить Google Play services до версии, требуемой Firebase Unity SDK, прежде чем вызывать любые другие методы в 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.
  }
});

Все готово! Ваш проект Unity зарегистрирован и настроен для использования Firebase.

Если у вас возникли проблемы с настройкой, посетите раздел «Устранение неполадок и часто задаваемые вопросы Unity» .

Настройка рабочего процесса на рабочем столе ( бета )

Когда вы создаете игру, зачастую гораздо проще сначала протестировать ее в редакторе Unity и на настольных платформах, а затем развернуть и протестировать на мобильных устройствах на более позднем этапе разработки. Для поддержки этого рабочего процесса мы предоставляем подмножество Firebase Unity SDK , которое можно запускать в Windows, macOS, Linux и из редактора Unity.

  1. Настройте проект Unity для настольной платформы, следуя тем же инструкциям, что и для мобильной платформы (начните с шага «Зарегистрируйте свое приложение в Firebase» выше).

  2. Запустите проект Unity в Unity IDE или выберите сборку проекта Unity для настольных компьютеров .

  3. (Необязательно) Запустите проект Unity в режиме редактирования.

    Firebase Unity SDK также можно запустить в режиме редактирования Unity, что позволяет использовать его в плагинах редактора.

    1. Когда вы создаете FirebaseApp , используемый редактором, не используйте экземпляр по умолчанию.

    2. Вместо этого укажите уникальное имя для вызова FirebaseApp.Create() .

      Это важно, чтобы избежать конфликта опций между экземпляром, используемым Unity IDE, и экземпляром, используемым вашим проектом Unity.

Поддерживаемые продукты Firebase

Подробнее о библиотеках Unity Firebase можно узнать в справочной документации .

Доступные библиотеки Firebase для мобильных устройств

Firebase Unity SDK поддерживает следующие продукты Firebase для Apple и Android :

Продукт Firebase пакет единства
AdMob Распространяется отдельно в плагине AdMob Unity.
Analytics FirebaseAnalytics.unitypackage
App Check FirebaseAppCheck.unitypackage
Authentication FirebaseAuth.unitypackage
Cloud Firestore FirebaseFirestore.unitypackage
Cloud Functions FirebaseFunctions.unitypackage
Cloud Messaging FirebaseMessaging.unitypackage
(рекомендуется) FirebaseAnalytics.unitypackage
Cloud Storage FirebaseStorage.unitypackage
Crashlytics FirebaseCrashlytics.unitypackage
(рекомендуется) FirebaseAnalytics.unitypackage
Dynamic Links FirebaseDynamicLinks.unitypackage
(рекомендуется) FirebaseAnalytics.unitypackage
Realtime Database FirebaseDatabase.unitypackage
Remote Config FirebaseRemoteConfig.unitypackage
(рекомендуется) FirebaseAnalytics.unitypackage

Доступные библиотеки Firebase для настольных компьютеров

Firebase Unity SDK включает поддержку рабочего процесса рабочего стола для подмножества продуктов, что позволяет использовать определенные части Firebase в редакторе Unity и в автономных сборках рабочего стола для Windows, macOS и Linux.

Продукт Firebase (компьютерная система) пакет единства
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 предоставляет остальные библиотеки рабочего стола в виде заглушек (нефункциональных) реализаций для удобства при сборке для Windows, macOS и Linux. Таким образом, вам не нужно условно компилировать код для настольного компьютера.

Следующие шаги