1. Look at the compilation errors in the Unity Editor's console tab and try to solve them. If play in editor still fails, proceed to the next step.
   • See the following articles for more information:
     • Unity: Fixing compiler errors before entering playmode
     • Unity: How do I interpret a compiler error?
2. If you have implemented firebase functionality into the code have you imported the appropriate Firebase packages? If play in editor still fails, proceed to the next step.
   • Either:
     • Add Firebase Unity SDKs
     • Look into and perform one of the alternatives in Additional Unity installation options.
3. If you have imported the packages as .unitypackages, have you made sure they are at the appropriate .NET API level?
   • Detailed here
4. Check that your editor is attempting to rebuild.
   • By default the Unity editor is set to rebuild whenever asset or configuration changes are detected.
   • It is possible (and sometimes desirable) that this functionality has been disabled and that your Unity Editor is set to manual refresh/recompile.
   • To Fix this either
     • Invoke manual refresh (Ctrl R on Windows or ⌘ R on Mac)
     • Enter Edit > Preferences > General and enable Auto Refresh

• If at any point you want or need more resolver and/or build information, consider enabling verbose logging and reading the log after trying to build again
  • to enable verbose logging do the following on
    • iOS
      • Enable "Verbose Logging" in Assets > External Dependency Manager > iOS Resolver > Settings
    • Android
      • Enable "Verbose Logging" in Assets > External Dependency Manager > Android Resolver > Settings
• If literally nothing in this document gets the game to build and run successfully, upgrade your install the newest LTS Unity Editor and update your packages.

Use Force Resolve if having issues with resolution

• When trying to build, if you receive errors, try to resolve android dependencies by clicking Assets > External Dependency Manager > Android Resolver > Resolve
  • If this fails, try Assets > External Dependency Manager > Android Resolver > Force Resolve
    • While this is slower, it is more dependendable as it clears old intermediate data
  • if the build is still failing try each of the following items in this list

JDK, SDK, NDK, Gradle Issues (including locating)

• Reasons to do this:
  • If Force Resolution is failing and you have not done this yet, try this.
  • If you receive error logs about Unity being unable to locate the JDK, Android SDK Tools or NDK
• What it does:
  • Toggling the external tool settings forces Unity to acknowledge them as it may not have loaded them properly.
• What to do:
  • Enter Unity->Preferences->External Tools
  • Toggle the JDK, Android SDK, Android NDK and Gradle checkboxes such that they have the oppsite value of what they started with
  • Toggle them back to their original values
  • Try force resolve and/or building again

Enable Maintemplate.gradle if you can

• If you do this you MUST enable Maintemplate.gradle (and custom gradle property template if using 2019.3 )
  • SYMPTOMS SHOWING YOU SHOULD DO THIS
    • When using the NONgradle version EDM4U will fail resolution when trying to bump up a package version number by changing it to <num>.0.
      Unity will TRY to decide on a version.

Enable Jetifier if you can

• Unless you have a solid reason NOT to enable Jetifier, ENABLE IT in EDM4U using Assets > External Dependency Manager > Android Resolver > Settings.
  • The option name is "Use Jetifier". Run "Resolve" or "Force Resolve" again after the setting is changed.
  • If you enabled Custom Gradle Properties Template, you can verify if Jetifier is properly enabled by checking "Assets/Plugins/Android/gradleTemplate.properties" and ensure EDM4U injected lines like "android.enableJetifier=true".
  • If you do this you MUST enable Maintemplate.gradle (and custom gradle property template if using 2019.3 )
  • SYMPTOMS SHOWING YOU SHOULD DO THIS
    • When using the NONgradle version EDM4U will fail resolution when trying to bump up a package version number by changing it to <num>.0.
      Unity will TRY to decide on a version.

'Single Dex' Issues and Minification

• If you run into an issue with "single dex"
  • Look into minification
    • Recommendation: Unless you absolutely must, do not apply different minification rules for different build configurations (debug vs release etc) as it can lead to confusion and make debugging more difficult.

Investigate Cocoapods if iOS resolution fails

• First of all make sure its properly installed
  • Verify that pod install and pod update run without errors in the folder where the Podfile is (usually the root folder of the Xcode project).
    • Cocoapods requires your terminal to be using UTF-8
      • Do this if you see the following in the cocoapods log
        WARNING: CocoaPods requires your terminal to be using UTF-8 encoding.

Win32 Errors when building Xcode Workspace/Project on Mac

• If the Unity Editor's console displays build output that mentions win32 errors, upgrade to a more recent LTS version of Unity after 2020.3.40f1.
  • Unity Bug
  • While this might seem extreme since there are a couple workarounds, upgrading is the fastest, most convenient and the most dependable method to deal with it.

Prefer opening Xcode Workspace files in Xcode to opening Xcode Projectr Files

• Try to build iOS builds from Xcode Workspaces generated by cocoapods rather than Xcode Projects:
  • Why?
    • Unity by default only generates Xcode project (.xcodeproject). If EDM4U is in the project, it, by default, uses Cocoapods to generate the Xcode Workspace (.xcworkspace) using the Podfile generated by EDM4U as well.
    • In this case, it is recommended to open the generated project by double-clicking on ".xcworkspace" instead of ".xcodeproject" since the former contains references to Firebase pods.
  • if you are building in an environment you cannot open Xcode workspaces from (such as unity cloud build) then alternatively go into the iOS resolver settings, enter the dropdown Cocoapods Integration and select "Xcode project"

Inspecting Logs

• On Simulator:
  • Inspect the logs displayed in your Emulator's console or view the Logcat window.
• On Device
  • Familiarize yourself with adb and adb logcat and how to use it.
    • While you can use your command line environments various tools to filter the output, consider alternatively looking into logcats options.
    • A simple way to start an ADB session with a clean slate and then going about whatever operation you care to do is:
      adb logcat -c && adb logcat <OPTIONS>
      where are whatever flags you pass the command line

Installing and Running on Simulator

• make sure to specify the CPU architecture of the machine you are running the emulator on in in File > Build Settings > Player Settings > Player > Android > Other Settings > Configuration > Target Architectures
  • If you do not do this, builds may succeed but be unable to install/run on the simulator

Inspecting Logs

• On Simulator
  • Look at lldb in Xcode
• On Device
  • Hook up to a computer and look at lldb in Xcode

Swift Issues

• If you run into an issues on trying to run the game with error logs that mention swift
  1. Make sure your project generates
     • a podfile AND
     • an xcworkspace file
  2. Make sure you are opening the xcworkspace file in Xcode rather than an Xcode project
  3. If the build is still not properly running on device, enable Enable Swift Framework Support Workaround in Assets > External Dependency Manager > iOS Resolver > Settings. Take a look at the description in the settings menu. Make sure those changes are made to the generated Xcode project.

Installing and Running on Simulator

• make sure to specify the Simulator SDK in File > Build Settings > Player Settings > Player > iOS > Other Settings > Configuration > Target SDK
  • If you do not do this, builds may succeed but be unable to install/run on the simulator