How can you add items to the Xcode project targets Info.plist using the XcodeAPI?

Is this possible with the XcodeAPI?

I need to add an API key and some boolean values to the generated xcode projects Info.plist. I don't see any examples on how to do that.

Perhaps it's outside the scope of the XcodeAPI? Any suggestions on how to do this using C# in a post build process function?

sim

 

Thank you! That worked perfectly.

We are using it for background location and fetch stuff in a native plugin.

Code (CSharp):

1. using UnityEngine;
2. using UnityEditor;
3. using UnityEditor.Callbacks;
4. using System.Collections;
5. using UnityEditor.iOS.Xcode;
6. using System.IO;
7.  
8. public class MyPluginPostProcessBuild
9. {
10.     [PostProcessBuild]
11.     public static void ChangeXcodePlist(BuildTarget buildTarget, string pathToBuiltProject)
12.     {
13.         if ( buildTarget == BuildTarget.iOS )
14.         {
15.             // Get plist
16.             string plistPath = pathToBuiltProject + "/Info.plist";
17.             PlistDocument plist = new PlistDocument();
18.             plist.ReadFromString(File.ReadAllText(plistPath));
19.            
20.             // Get root
21.             PlistElementDict rootDict = plist.root;
22.            
23.             // background location useage key (new in iOS 8)
24.             rootDict.SetString("NSLocationAlwaysUsageDescription", "Uses background location");
25.            
26.             // background modes
27.             PlistElementArray bgModes = rootDict.CreateArray("UIBackgroundModes");
28.             bgModes.AddString("location");
29.             bgModes.AddString("fetch");
30.            
31.             // Write to file
32.             File.WriteAllText(plistPath, plist.WriteToString());
33.         }
34.     }
35. }

Need some clarification.
Do I need to download the XcodeAPI and include it in my project if we are already using Unity 5 (5.0.2p3)? It already seems to be included, though I'm guessing it's not the newest version.

Would this work with 4.6.5? Would that require including the XcodeAPI like you instructed?

Am I correct in assuming this would also work with Unity Cloud Build?

 

Thanks, i used the sample code shown above and was able to modify the Info.plist to add what i wanted.
The major issue was only understanding what's the name of the element i need to be added

In my book, a good API is one that can be used straight away without reading through docs, etc.... (naming conventions are good and it's hard to find your way around).

So, good work guys, Thanks !!!!

 

Found the answer a bit confusing until I realized I didn't need to actually download the API in Unity version 5.1.1

 

it works great.
I already made a hack, that I set the version to 1.0.0#1, and then parse it in the post-build-processor.

Is there a way to make cloudbuild auto-increment everytime it builds?

 

hey David, some useful posts again. many thanks (you answered my iOS question too!)...

can I ask two things.

1. is there a similar routine for Android's manifest.xml ?
2. Alternatively, is there anyway to just include hard coded plist or manifest files for iOS and Android respectively ?...

I'm extending both to include a custom url scheme e.g. mygamename://

 

thanks

just to confirm...

so for android we just add a manifest to the Assets/Plugins/Android folder

and RTM for Xcode manipulation API !

 

I'm getting lots of errors in PBXProject.cs, like:

Error CS0234: The type or namespace name `CombinePaths' does not exist in the namespace `UnityEditor.Utils'. Are you missing an assembly reference? (CS0234) (Assembly-CSharp-Editor)

In Unity 4.6.8p3

Any ideas?

 

Hi,

I'm trying to add URL Schemes to my Info.plist.

While adding frameworks is working just fine, accessing the root dictionary of my plist doesn't seem to work as expected:

Code (CSharp):

1. // Add url schema to plist file
2. string plistPath = path + "/Info.plist";
3. PlistDocument plist = new PlistDocument();
4. plist.ReadFromString(File.ReadAllText(plistPath));
5.            
6. // Get root
7. PlistElementDict rootDict = plist.root;

When I step debug the code, Mono Develop shows me

FYI, the plistPath is correct.

Am I doing anything wrong?

 

Which is the correct version for 4.6?

 

That's the version (latest commit) that gives me errors in Unity 4.6. Same ones that @peterworth mentioned: Namespace CombinePaths does not exist in namespace UnityEditor.Utils, etc. That's why I thought when you mentioned right version you meant a commit version, I just assumed the latest was only written for Unity 5.

 

Yes!

 

Try insert "using Utils = PBX.Utils;"

 

how to get the path of Classes/UI/UnityViewControllerBase.mm

 

I totally missed that this had been added.. awesome work guys. So great to have a tidy compile process again and not have to worry about manually editing a plist. The whole API looks so well written, thanks!!

Are their some docs somewhere or more examples? I'd love to know how to add in a folder reference of assets to the xcode project - something I need to manually do every build, and to also add frame works. Thanks again!! =)

 

I don't think the API is documented. You can look at this link for some samples: http://forum.unity3d.com/threads/ucb-demos.306687/

Maybe it'll cover what you need.

 

Thanks! =)

 

How can I add embedded framework via XCode api?

 

Is this a framework that you added to your project (e.g: plugin), or something that is build-in and should already exist in Xcode ?

 

I want to add not build-in framework

 

And did you try to add it using the XcodeAPI (like the examples linked above) ?

 

I found this thread http://forum.unity3d.com/threads/is...s-to-the-embedded-binaries-build-step.358357/, and this issue https://issuetracker.unity3d.com/issues/Embedded-Binaries-function-in-XCode-Manipulation-API

but, I dont know when it will add to api, or maybe its added already?

 

Hey, so far this is great example working with making new array elements! Works for me.

Could it be possible to get an example of how to create a new boolean in the info.plist?
For example, "Application supports iTunes file sharing" and set it to "YES".

I try to write the script, and I can't find a way to ".CreateBool", so I guess it some kind of conversion from a Dict/Array, but for me all combinations I try with .AsBoolean result in error.

Here is my code fail based on the original example:

Code (CSharp):

1. PlistElementBoolean iTunesFileSupport = rootDict.CreateArray("Application supports iTunes file sharing");
2.             iTunesFileSupport.AsBoolean(true);

What am I doing wrong?
Help/Tips/Examples appreciated!

 

I don't know if this post is correct for my question, but i'll write it anyway, just correct me if i'm wrong.

I'm interested in adding new target to XCode project. Can I do it with code, adn if yes, how can I?

 

We are also very interested in automatically adding targets, especially App Extensions (Sticker Packs, iMessage Extensions and Notification Content Extensions). With the release of iOS 10 App extensions have become a very important part to the user interaction and experience with the apps.

There is an open thread at:
http://forum.unity3d.com/threads/ho...sions-to-unity-ios-build.287183/#post-2793951

But there is no response from UT yet. @David-Berger, do you know if integrating App extensions is feasible via Xcode API and Cloud Build?

 

I am following all the described steps and I have the following error in Unity:
PXPorject.cs [...]: The type or namespace 'CombinePaths' does not exist in the namespace 'UnityEditor.Utils'

Am I missing something?

 

@peterworth

Somehow, Utils are giving errors. Double click on errors and replace Utils with PBX.Utils

 

hi david sir.
please guide me for make printing functionality in IOS and Android device

 

Hi there, does anyone know how to manipulate the xcode project to turn the Push Notifications capability on as a post-process? I found one suggestion on answers but does nothing at all for me, and even manually turning it on does not change the plist file so I think the suggestion is off track: http://answers.unity3d.com/questions/1066927/postprocessing-ios-activate-background-mode-for-pu.html thanks!!

 

Ahhh.. nevermind. I JUST found literally the top pinned iOS thread on this topic.. https://forum.unity3d.com/threads/how-to-put-ios-entitlements-file-in-a-unity-project.442277/

 

Is it possible to use the same for OSX?

https://docs.unity3d.com/ScriptReference/iOS.Xcode.PBXProject.html

 

Update for people seeing this article going forward.

At some point in Unity 5.x, Unity included the code directly in the iOS support install, so no need to download the extra code referenced above. However, doing that there is one requirement not explicitly stated in the docs. Your C# class file should be placed under /Assets/Editor folder. That was the only way to get Visual Studio Mac to recognize the UnityEditor.iOS.Xcode namespace and ultimately for the code to compile.

Great example from David-Berger, very helpful.

 

2019

Absolutely up-to-date version of this
which works perfectly
and shows all options and details:

https://stackoverflow.com/a/54370793/294884

 

@Fattie,

thanks for posting this update. I'm having an issue where it seems that Unity 2018.3.5f1 appears to be overwriting the info.plist after the postprocessbuild step runs.

I posted a question, referencing your link here: https://stackoverflow.com/questions...info-plist-overwritten-after-postprocessbuild

Any insights would be very helpful as it's not working in 2018.3.5f1.

 

@philmuse (Sorry, I am just back online) the resolution you found for that problem is awesome, thanks

Fantastic information on ordering:

https://stackoverflow.com/a/55035656/294884

 

This process does not seem to work for standalone Mac builds.

I installed the iOS build support, to no avail. There is nothing of use in the documentation that explicitly mentions Mac support.

I would like to have access to editing the Info.plist for my Mac build.

Which dll/assembly contains the specific classes? I cannot find a dll named "UnityEditor.iOS.Xcode", but there is one called "UnityEditor.Extensions.iOS.Xcode". I'm not sure if it's safe to assume that namespaces and dll names usually match or not. I would assume that they don't have to, but usually would.

 

@Fattie Thanks for your sharing. It works for my game.

 

I have tried at least 20 different solutions. So,how can I enable push notification according to the latest solution from this post: https://stackoverflow.com/questions...ameworks-settings-and-plist/54370793#54370793

 

@bgulanowski Did you manage to get it working on macOS? If so how?

 

I'm trying to add a string array to plist for Bonjour Services. It writes it to the plist, but I still get an error in Xcode while building. Deleting the plist entry for Bonjour Services and adding the exact same information in Xcode resolves the issue.

Code (CSharp):

1. rootDict.SetString("Privacy - Local Network Usage Description", "For shared AR");
2. PlistElementArray b = rootDict.CreateArray("Bonjour services");
3. b.AddString("_myCollabSession._tcp");
4. b.AddString("_myCollabSession._udp");
5. File.WriteAllText(plistPath, plist.WriteToString());

Off these, both are written to the plist, and the first entry (Privacy..) throws no errors while building, while Bonjour services does. Anyone has an idea of what I'm doing wrong?

 

Perhaps it's just the syntax you're using? It looks correct but the Unity examples do it slightly differently, like this:

Code (CSharp):

1. var ser = (rootDict["Bonjour services"] = new PlistElementArray()) as PlistElementArray;
2. ser.values.Add(new PlistElementString("_myCollabSession._tcp"));
3. ser.values.Add(new PlistElementString("_myCollabSession._udp"));

Also, I think the array name has to be "NSBonjourServices" rather than "Bonjour services" which is what you had. (see pic)