Unity3D has pretty good documentation available online but some things are quite badly documented. We have collected here some of those cryptic areas that are frequently asked for on several Internet discussion boards.
This code is tested and actually used in our products, so it should work :)
We are using MacOS for development but all these should also work on other platforms.
As you all know Unity keeps logging a lot and it is often required to add logging to your own code to solve more complex problem cases. But how to remove the logging totally from production/customer builds?
You can solve this by replacing UnityEngine.Debug.Log() with this kind of code and just log using Log.d("my error");
Caution: This code enables the function only in the Unity Editor so if you need logging in some other build (etc. Android debug build) you need to remove/comment that conditional-line.
namespace MYCOMPANY
{
public class Log
{
[System.Diagnostics.Conditional("UNITY_EDITOR")]
public static void d(object message)
{
UnityEngine.Debug.Log(message);
}
}
}
Here you learn how to modify the build before binary compilation using Xcode or Android compilers.
You have probably already noticed that Unity does not have all the settings you need for your product. Basically you often need to add or modify the IOS build Info.plist or tweak the Android manifest or resources.
We are using this script to increase build numbers and to modify the IOS build information before compiling the binary using Xcode.
It can do at least these things:
You should put this file in the Assets/Editor folder and modify it to fulfil your needs.
You often need to add or modify the Unity Android build in order to make everything work properly.
Google PlayStore builds often require some additonal fields/information and tweaking the AndroidManifest.xml file.
We are using this script to modify the Android build information during the build process.
It is used to add some extra fields to the Manifest and other information needed by different 3rd party libraries.
This example also adds the Epic Online Services ClientID to the strings.xml, which is needed for Epic login purposes.
This script also shows you how to allow cleartext traffic, add permissions, localization for push messaging etc.
If you add Firebase SDK to your project or some other SDK that replaces the Unity default launch activity, you might need to add a description for your game view. This might be a bug in some Unity versions but anyways this script will show you how to add that string resource.
You should put this file in the Assets/Editor folder.
We are using this build script to add a menu item to build the project using different architectures and/or settings. This script will also be called outside Unity (shell script) to start a build without manually starting the Unity editor.
This approach enables you to build versions automatically for each platform or to configure some daily builds etc. You should put this file in the Assets/Editor folder and modify it to fulfil your needs.
Lets first check the minimal class for starting an IOS build. You'll gradually learn how to do everything you need.
using System;
using System.Diagnostics;
using System.IO;
using UnityEditor;
using UnityEditor.AddressableAssets.Settings;
using UnityEditor.Build.Reporting;
public class AutoBuilder
{
[MenuItem("File/AutoBuilder/iOS")]
static void BuildIOS()
{
#if UNITY_IOS && UNITY_EDITOR
PlayerSettings.iOS.appleEnableAutomaticSigning = false;
PlayerSettings.iOS.iOSManualProvisioningProfileType = ProvisioningProfileType.Distribution;
#endif
string[] scenes = { "Assets/Scenes/InitStaticScene.unity", "Assets/Scenes/LoginScene.unity", "Assets/Scenes/MainMenuScene.unity" };
string buildPath = "/tmp/IOS_auto";
// Create build folder if not yet exists
Directory.CreateDirectory(buildPath);
EditorUserBuildSettings.development = false;
BuildLauncher.BuildAddressables();
BuildReport status = BuildPipeline.BuildPlayer(scenes, buildPath, BuildTarget.iOS, BuildOptions.None);
if(status.summary.result == BuildResult.Succeeded)
{
// maybe print a debug message ... all OK
}
}
}
Obviously you need to change your own path for this automatic IOS build and define the scenes manually or reading the list automatically. Also as you can see we define for Xcode whether to use automatic signing or manual, build type (distribution or development) and also the Unity build type (development or not). If this does not work and Xcode says something about the signing keys, provisioning profiles etc. you must first run Xcode yourself and tweak the settings there and maybe sync profiles from the Appstore. So make it compile manually first and then it should just work.
For development build we changed:
PlayerSettings.iOS.iOSManualProvisioningProfileType = ProvisioningProfileType.Development;
EditorUserBuildSettings.development = true;
BuildReport status = BuildPipeline.BuildPlayer(scenes, buildPath, BuildTarget.iOS, BuildOptions.Development | BuildOptions.CleanBuildCache | BuildOptions.AllowDebugging);
You can call this build script from shell:
/Applications/Unity/Hub/Editor/YOUR_UNITY_VERSION/Unity.app/Contents/MacOS/Unity -quit -batchmode -buildTarget iOS -executeMethod AutoBuilder.BuildIOS -email YOUR_UNITY_EMAIL -password YOUR_UNITY_PASSWORD
// FOR IOS YOU NEED TO GO TO YOUR BUILD DIRECTORY AND START THE XCODE BUILD
xcodebuild -scheme Unity-iPhone -workspace Unity-iPhone.xcworkspace -destination generic/platform=IOS -configuration AppStoreDistribution archive -archivePath ../IOS_archive/Universal.xarchive
// AND THEN TO ARCHIVE IT TO AN IPA FILE FOR Appstore
xcodebuild -exportArchive -archivePath IOS_archive/Universal.xarchive.xcarchive -exportOptionsPlist ExportOptions.plist -exportPath IOS_archive
// THEN YOU COULD USE FASTLANE OR SOME OTHER TOOL TO UPLOAD IT AUTOMATICALLY TO TESTFLIGHT
The same thing for Android - Bundle for Google Play
[MenuItem("File/AutoBuilder/Android AAB for PlayStore")]
static void BuildAndroid()
{
#if UNITY_ANDROID && UNITY_EDITOR
PlayerSettings.Android.keystorePass = "xxxx";
PlayerSettings.Android.keyaliasName = "xxxx";
PlayerSettings.Android.keyaliasPass = "xxxx";
PlayerSettings.Android.splitApplicationBinary = true;
PlayerSettings.Android.targetArchitectures = AndroidArchitecture.All;
#endif
string[] scenes = { "Assets/Scenes/InitStaticScene.unity", "Assets/Scenes/LoginScene.unity", "Assets/Scenes/MainMenuScene.unity" };
string buildPath = "/tmp/Android_auto";
// Create build folder if not yet exists
Directory.CreateDirectory(buildPath);
if(File.Exists(buildPath + "/universal.aab")) File.Delete(buildPath + "/universal.aab");
// Enable app bundle for Google Play
EditorUserBuildSettings.buildAppBundle = true;
EditorUserBuildSettings.development = false;
BuildLauncher.BuildAddressables();
BuildReport status = BuildPipeline.BuildPlayer(scenes, buildPath+"/universal.aab", BuildTarget.Android, BuildOptions.None);
if (status.summary.result == BuildResult.Succeeded)
{
// maybe print a debug message ... all OK
}
}
For development build we changed:
PlayerSettings.Android.splitApplicationBinary = false;
PlayerSettings.Android.targetArchitectures = AndroidArchitecture.ARMv7; // no need to do several builds?
if(File.Exists(buildPath + "/universal.apk")) File.Delete(buildPath + "/universal.apk");
EditorUserBuildSettings.buildAppBundle = false;
EditorUserBuildSettings.development = true;
BuildReport status = BuildPipeline.BuildPlayer(scenes, buildPath+"/universal.apk", BuildTarget.Android, BuildOptions.Development | BuildOptions.CleanBuildCache | BuildOptions.AllowDebugging);
You can call this build script from shell:
/Applications/Unity/Hub/Editor/YOUR_UNITY_VERSION/Unity.app/Contents/MacOS/Unity -quit -batchmode -buildTarget Android -executeMethod AutoBuilder.BuildAndroid -email YOUR_UNITY_EMAIL -password YOUR_UNITY_PASSWORD
// THEN YOU COULD USE FASTLANE OR SOME OTHER TOOL TO UPLOAD IT AUTOMATICALLY TO GOOGLE PLAY STORE INTERNAL TESTING
After automated builds you probably want to upload the builds to AppStore TestFlight and Google Play store internal track
Here is an example fastlane Fastfile that will publish the apps to stores. You need to modify the credentials, paths etc.
For AppStore you first need to make an AppStore Connect API key in Apple's development portal. This Fastfile contains the path the key and also key_id, issuer_id etc.
For Google Play store you need to make a Google Cloud API key and allow that virtual user to publish at least beta releases on your behalf.
Check the fastlane documentation .. it is quite easy to install and use & very well documented. It is also able to increase build numbers, sign the application etc.
Your automated build scripts will also upload the build to TestFlight internal and/or Google Play Store internal track so we can install all the test releases automatically to all the devices.
# IOS release to TestFlight
lane :release do
api_key = app_store_connect_api_key(
key_id: "YOUR_KEY_ID",
issuer_id: "YOUR_ISSUER_ID",
key_filepath: "/PATH_TO_YOUR_KEY/MYKEY.p8",
duration: 1200, # optional (maximum 1200)
in_house: false # optional but may be required in some cases
)
upload_to_testflight(
api_key: api_key,
skip_submission: true,
ipa: "/PATH_TO_YOUR_IPA_FILE/MYFILE.ipa",
skip_waiting_for_build_processing: true,
)
end
# Google Play Store internal track
lane :playstore do
upload_to_play_store(
track: "internal",
validate_only:false,
release_status:"draft", # only draft is possible until one review, so you need to manually approve it in Google Play store console
json_key:"/PATH_TO_GOOGLE_CLOUD_KEY/MYKEY.json",
package_name:"com.mycompany.mypackage",
aab:"/PATH_TO_YOUR_ABB_FILE/MYFILE.aab",
skip_upload_metadata: true,
skip_upload_changelogs: true,
skip_upload_images: true,
skip_upload_screenshots: true,
timeout: 600
)
end