How to put iOS entitlements file in a Unity project

I will show you how to include iOS's entitlements file in a Unity project and how to hand it over to Xcode project.
I did this research out of my own need.
I'm using this to automatically add "Associated Domains" to the generated Xcode project.

Like you and many other Unity users, I was somewhat confident in Unity's ability to handle complex things.
So I tried putting a file which has .entitlements as it's extension in a project
just to find out disappointing result that It has no effect.

Then I searched and scouted around for an easy aid for hours but with no success.

Only thing I could do was to create a script I need by myself.

Usage:
1) Import EntitlementsPostProcess.unitypackage.
2) Inside Xcode trim Capabilities and let Xcode create an entitlements file.
3) Copy the entitlements file created into Unity project.
4) Hook up your entitlements file within the inspector view of EntitlementsPostProcess.cs

Links to documents:
https://docs.unity3d.com/ScriptReference/Callbacks.PostProcessBuildAttribute.html
https://docs.unity3d.com/ScriptReference/iOS.Xcode.PBXProject.html

Tested with Unity 5.3.5f1 and Xcode 8.1
It should work with Unity 5.4 too.

Spoiler: EntitlementsPostProcess.cs

Code (CSharp):

1. using UnityEngine;
2. using UnityEditor;
3. using UnityEditor.Callbacks;
4. using UnityEditor.iOS.Xcode;
5. using System.Collections;
6. using System.IO;
7.  
8.  
9. public class EntitlementsPostProcess : ScriptableObject
10. {
11.     public DefaultAsset m_entitlementsFile;
12.  
13.     [PostProcessBuild]
14.     public static void OnPostProcess(BuildTarget buildTarget, string buildPath)
15.     {
16.         if (buildTarget != BuildTarget.iOS)
17.         {
18.             return;
19.         }
20.  
21.         var dummy = ScriptableObject.CreateInstance<EntitlementsPostProcess>();
22.         var file = dummy.m_entitlementsFile;
23.         ScriptableObject.DestroyImmediate(dummy);
24.         if (file == null)
25.         {
26.             return;
27.         }
28.  
29.         var proj_path = PBXProject.GetPBXProjectPath(buildPath);
30.         var proj = new PBXProject();
31.         proj.ReadFromFile(proj_path);
32.  
33.         // target_name = "Unity-iPhone"
34.         var target_name = PBXProject.GetUnityTargetName();
35.         var target_guid = proj.TargetGuidByName(target_name);
36.         var src = AssetDatabase.GetAssetPath(file);
37.         var file_name = Path.GetFileName(src);
38.         var dst = buildPath + "/" + target_name + "/" + file_name;
39.         FileUtil.CopyFileOrDirectory(src, dst);
40.         proj.AddFile(target_name + "/" + file_name, file_name);
41.         proj.AddBuildProperty(target_guid, "CODE_SIGN_ENTITLEMENTS", target_name + "/" + file_name);
42.  
43.         proj.WriteToFile(proj_path);
44.     }
45. }
46.  

 

Yay thank you so much! I was worried I'd never stop scratching my head getting push notifications to work in Unity Cloud Build but this saved me!

 

This worked brilliantly as per my post:
https://forum.unity3d.com/threads/h...on-capability-using-unity-cloud-build.457812/

Thanks so much @a_p_u_r_o

 

Many thanks @a_p_u_r_o.

 

This is great, thanks @a_p_u_r_o

 

Perfect! Slove my problem to turn on push notifications automaticly!
Thanks so much @@a_p_u_r_o

 

Great answer and solved my problem on enabling iCloud automactically!
Now I am wondering how can I enable IAP and GameCenter by default too? Since they doesn't need entitlement file? (Now I still need to manually turn these 2 on)

 

As I consider this thread to consist of notions which are already a bit hard to understand,
I feel like mixing up no further complexity.
Therefore, @SweatyChair, I suggest you to create a new thread.
I am certain that your problem here will be treated in a totally different way.

 

I tried the instructions shared here by a_p_u_r_o; however when i upload the IPA file generated by cloud build via application loader i get several errors due to ERROR ITMS-90045 Invalid Code Signing Entitlements" on several keys e.g. UILuanchStoryBoardName, UIApplicationExitOnSuspend etc. Any suggestions? Thanks

 

Go to this thread https://forum.unity3d.com/threads/automatic-turn-on-in-app-purchase-capabilities-in-ios.474283/
I am also finding a solution.

 

igot this error ...please any idea .... will pareciate so much
//
.

 

Thanks, that was just what the Doctor ordered

One thing though: on my local setup, I found that the script would fail when appending to an existing project since the entitlements file was already there. Easy fix was to just delete it first:

Insert

FileUtil.DeleteFileOrDirectory(dst);

Before the FileUtil.Copy(...).

 

Thank you. your work is great!!!

 

There is also this method:

Code (CSharp):

1. PBXProject.AddCapability(targetGuid,PBXCapabilityType,entitlementFileName,addOptionalFramework,framework)

Calling it with an empty PListDocument entitlements file didn't add the capability though :?

 

Thats GREAT!
But, how can I get this .entitlements file? I opened the XCode and configure the capabilities, but the .entitlements file do not changed and just have this content.

Code (CSharp):

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3. <plist version="1.0">
4. <dict>
5.     <key>aps-environment</key>
6.     <string>development</string>
7. </dict>
8. </plist>
9.  

How i change that file and make all the process?

 

how about unity officially integrate this in the player settings?

 

i want add my audio files

FileUtil.CopyFileOrDirectory(Application.dataPath + "/chching.wav", buildPath+"/"+target_name+"/chching.wav");
proj.AddFile(target_name + "/chching.wav","/chching.wav");


file is added but not working , when i drag and drop file in xcode its working.

can you help me with this

 

i want to add my custom sound for notification

FileUtil.CopyFileOrDirectory(Application.dataPath + "/chching.wav", buildPath+"/"+target_name+"/chching.wav");
proj.AddFile(target_name + "/chching.wav","/chching.wav");


file is added but not working , when i drag and drop file in xcode its working.

can you help me with this

 

I don't get the solution in that thread, it was closed and it seems likely people need to manually set up IAP and Game center flag inside xcode project rather writing postbuild ios.

I also tried this https://bitbucket.org/snippets/Eyeoness/eaong . However, it just doesn't work. Unity shows log successfully writing the SystemCapabilities, however, when open file pbxproj, nothing changes. It seems likely somewhere overwrite my method.

Any advise to enable IAP and Game Center via post build process Unity ios.

 

We are using Unity cloud build for our ios app. Is there any way to enable to add basic capabilities like IAP and GameCenter in Unity 5.6? Or we are forced to switch to Unity 2017 / 2018 in order to make this work?

 

Is it possible to use xCode Api (https://bitbucket.org/Unity-Technologies/xcodeapi) with Unity 5.6?

 

Thank you @a_p_u_r_o !

 

Are there anyway I could use this API in unity 5.6.6?

 

the module should be included since Unity 5.0, or was the method added later? If so you can load the latest version of the xcode api https://bitbucket.org/Unity-Technologies/xcodeapi/overview (it uses the namespace UnityEditor.iOS.Xcode.Custom, so it doesn't conflict with the bundled version)

 

it do not add this capability which is bad because actually it looks like it should

 

var projectcapabilitymanager = new ProjectCapabilityManager(projPath,dst,"Unity-iPhone");
projectcapabilitymanager.AddInAppPurchase();
doesnt works also

 

alright adding StoreKit.framewokr automatically adds the Capability to an xcode (or with a conjunction with those lines above dont wont to test that separately really)
proj.AddFrameworkToProject(target_guid, "StoreKit.framework", false);

 

One of the most helpful threads here , thanks @a_p_u_r_o !

 

It throws exception on build:

Code (CSharp):

1. IOException: Failed to Copy File / Directory from 'Assets/Sample.entitlements' to '/Users/rico345100/Desktop/development/unity/Stick-Warfare-Blood-Strike-iOS/Build/SWBS/9D25AB9C213FB47800354C27/Sample.entitlements'.
2. UnityEditor.FileUtil.CopyFileOrDirectory (System.String source, System.String dest) (at /Users/builduser/buildslave/unity/build/Editor/Mono/FileUtil.bindings.cs:35)
3. EntitlementsPostProcess.OnPostProcess (UnityEditor.BuildTarget buildTarget, System.String buildPath) (at Assets/Editor/EntitlementsPostProcess.cs:39)
4. System.Reflection.MonoMethod.Invoke (System.Object obj, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) (at <fb001e01371b4adca20013e0ac763896>:0)
5. Rethrow as TargetInvocationException: Exception has been thrown by the target of an invocation.
6. System.Reflection.MonoMethod.Invoke (System.Object obj, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) (at <fb001e01371b4adca20013e0ac763896>:0)
7. System.Reflection.MethodBase.Invoke (System.Object obj, System.Object[] parameters) (at <fb001e01371b4adca20013e0ac763896>:0)
8. UnityEditor.Build.BuildPipelineInterfaces+AttributeCallbackWrapper.OnPostprocessBuild (UnityEditor.Build.Reporting.BuildReport report) (at /Users/builduser/buildslave/unity/build/Editor/Mono/BuildPipeline/BuildPipelineInterfaces.cs:177)
9. UnityEditor.Build.BuildPipelineInterfaces+<>c__DisplayClass17_0.<OnBuildPostProcess>b__1 (UnityEditor.Build.IPostprocessBuildWithReport bpp) (at /Users/builduser/buildslave/unity/build/Editor/Mono/BuildPipeline/BuildPipelineInterfaces.cs:433)
10. UnityEditor.Build.BuildPipelineInterfaces.InvokeCallbackInterfacesPair[T1,T2] (System.Collections.Generic.List`1[T] oneInterfaces, System.Action`1[T] invocationOne, System.Collections.Generic.List`1[T] twoInterfaces, System.Action`1[T] invocationTwo, System.Boolean exitOnFailure) (at /Users/builduser/buildslave/unity/build/Editor/Mono/BuildPipeline/BuildPipelineInterfaces.cs:391)
11. UnityEditor.EditorApplication:Internal_CallGlobalEventHandler() (at /Users/builduser/buildslave/unity/build/Editor/Mono/EditorApplication.cs:442)
12.