automated post process frameworks

Hi,

Is there a specific bit of code you're having trouble with, that you can post here?

Some things to keep in mind when using the PBXProject API are:

Use the [PostProcessBuild] attribute, and use the correct function signature.

See https://docs.unity3d.com/ScriptReference/Callbacks.PostProcessBuildAttribute.html

Unity will run a [PostProcessBuild] function after doing the build. Your function must return void and take two parameters, a BuildTarget target and a string pathToBuiltProject. The BuildTarget tells you which platform the build was for, and the string tells you where the build was saved. So for example if you were only interested in processing an iOS build, you could return from the function if the BuildTarget was anything other than BuildTarget.iOS:

 [PostProcessBuild]
 private static void PostprocessBuild(BuildTarget target, string pathToBuiltProject)
 {
     if (target != BuildTarget.iOS)
         return;

The string is the location of the build. For iOS, this is the location of the folder that contains the Unity-iPhone.xcodeproj file. So in order to access the project.pbxproj file you need to do something like this:

 string pbxFilename = pathToBuiltProject + "/Unity-iPhone.xcodeproj/project.pbxproj"

Load the file into your PBXProject instance

After instantiating a new PBXProject, you need to load the data from the file on disk into your instance. Use PBXProject.ReadFromFile, ReadFromString or ReadFromStream.

 PBXProject proj = new PBXProject();
 proj.ReadFromFile (pbxFilename);

Add your framework

This is the easy part, just call PBXProject.AddFrameworkToProject. For the first parameter, pass in the result of PBXProject.TargetGuidByName, passing in the string returned by PBXProject.GetUnityTargetName. The second parameter is the name of the framework, and the third specifies whether it is optional (i.e. false means required).

For example, to add ARKit.framework to your project, do this:

 string targetName = PBXProject.GetUnityTargetName ();
 string guid = proj.TargetGuidByName (targetName);

 proj.AddFrameworkToProject(guid, "ARKit.framework", false);

Write the project back to disk

This is an easy step to forget. Use one of PBXProject.WriteToFile, WriteToStream or WriteToString to serialize the PBXProject instance back out to disk:

 proj.WriteToFile (pbxFilename);

Putting it all together

Putting all the previous steps together, here is a minimal C# script that does the following:

• Early-exits of the build is not for iOS

• Creates a PBXProject instance, and loads the data in from the project.pbxproj file.

• Adds ARKit.framework.

• Saves back out to the project.pbxproj file.

   public class MyBuildScript {
       
       [PostProcessBuild]
       private static void PostprocessBuild(BuildTarget target, string pathToBuiltProject)
       {
           Debug.LogFormat ("Postprocessing build at \"{0}\" for target {1}", pathToBuiltProject, target);
           if (target != BuildTarget.iOS)
               return;
   
           PBXProject proj = new PBXProject();
           string pbxFilename = pathToBuiltProject + "/Unity-iPhone.xcodeproj/project.pbxproj";
           proj.ReadFromFile (pbxFilename);
   
           string targetName = PBXProject.GetUnityTargetName ();
           string guid = proj.TargetGuidByName (targetName);
           proj.AddFrameworkToProject(guid, "ARKit.framework", false);
   
           proj.WriteToFile (pbxFilename);
       }
   }