Project Setup Tool

• Target Group: Switch between the different build target groups to see the list of tasks that apply to each target group.
• Filter by Group: Lets you filter the tasks by group such as packages, compatibility, features, and rendering.
• Fix All: It goes through all the outstanding settings that are necessary for a Meta Quest app.

• Background Checks: A toggle that enables continuous background checks on the project’s status and rules.
• Required throw errors: Uncheck to ignore failing tasks when building/running.
• Log outstanding issues: Uncheck to remove any logs in the console. This would prevent log spam if any.
• Show Status Icon: Uncheck to hide the status icon on the bottom right of the editor.
• Produce Report on Build: Generate a json report which lists all the rules and their status for the current build target.

• Fix/Apply: Manually call the fix delegate for this Task in order to resolve the issue. This action is only available for tasks that are not already validated.
• Documentation: Open the related documentation following the specified URL in the Configuration Task description. If no URL has been specified, this option is not visible.
• Ignore / Unignore: This moves the task to another category that will get ignored for both checks and fixes. This gives the control back to developers who may not want to be forced to follow some guidelines or even requirements in some specific cases.

public static void OVRProjectSetup.AddTask(
        OVRProjectSetup.TaskGroup group,
        Func<BuildTargetGroup, bool> isDone,
        BuildTargetGroup platform = BuildTargetGroup.Unknown,
        Action<BuildTargetGroup> fix = null,
        OVRProjectSetup.TaskLevel level = OVRProjectSetup.TaskLevel.Recommended,
        Func<BuildTargetGroup, OVRProjectSetup.TaskLevel> conditionalLevel = null,
        string message = null,
        Func<BuildTargetGroup, string> conditionalMessage = null,
        string fixMessage = null,
        Func<BuildTargetGroup, string> conditionalFixMessage = null,
        string url = null,
        Func<BuildTargetGroup, string> conditionalUrl = null,
        bool validity = true,
        Func<BuildTargetGroup, bool> conditionalValidity = null);

• This method creates, adds and registers an OVRConfigurationTask to the Setup Tool. Note that the Message or ConditionalMessage parameters must be unique, as they are hashed to generate a Unique ID for the task.
• Once added, tasks are not meant to be removed from the Setup Tool and will be checked at key points.
• This method is the entry point for developers to add sanity checks, technical requirements, or recommendations.
• Use conditional parameters with lambdas or delegates for more complex behaviors if needed.

• group: Category that fits the task. Feel free to add more to the enum if relevant. Do not use “All”.
• isDone: Delegate that checks if the Configuration Task is validated or not.
• platform: Platform for which this Configuration Task applies. Use “Unknown” for any.
• fix: Delegate that validates the Configuration Task.
• level: Severity (or behaviour) of the Configuration Task.
• conditionalLevel: Use this delegate for more control or complex behaviours over the level parameter.
• message: Description of the Configuration Task.
• conditionalMessage: Use this delegate for more control or complex behaviours over the message parameter.
• fixMessage: Description of the actual fix for the Task.
• conditionalFixMessage: Use this delegate for more control or complex behaviours over the fixMessage parameter.
• url: Url to more information about the Configuration Task.
• conditionalUrl: Use this delegate for more control or complex behaviours over the url parameter.
• validity: Checks if the task is valid. If not, it will be ignored by the Setup Tool.
• conditionalValidity: Use this delegate for more control or complex behaviours over the validity parameter.

• ArgumentNullException: Possible causes:
  • If either message or conditionalMessage do not provide a valid non-null string.
  • isDone is null.
  • fix is null.
• ArgumentException: Possible causes:
  • group is set to “All”. This category is not meant to be used to describe a task.
  • A task with the same unique ID already has been registered (conflict in hash generated from description message).

• This task is a Recommendation.
• It will be shown in the Quality category.
• Its description message is: Set Texture Quality to Full Res.
• Both isDone and fix functions are pretty straightforward and directly test or alter the QualitySettings of the project.

OVRProjectSetup.AddTask(
    level: OVRConfigurationTask.TaskLevel.Recommended,
    group: OVRConfigurationTask.TaskGroup.Quality,
    message: "Set Texture Quality to Full Res",
    isDone: buildTargetGroup => QualitySettings.masterTextureLimit == 0,
    fix: buildTargetGroup => QualitySettings.masterTextureLimit = 0
);

OVRProjectSetup.AddTask(
    conditionalValidity: buildTargetGroup => OVRProjectSetupUtils.PackageManagerListAvailable,
    level: OVRConfigurationTask.TaskLevel.Required,
    group: OVRConfigurationTask.TaskGroup.XR,
    isDone: buildTargetGroup => OVRProjectSetupUtils.IsPackageInstalled(OculusXRPackageName),
    message: "The Oculus XR Plug-in package must be installed",
    fix: buildTargetGroup => OVRProjectSetupUtils.InstallPackage(OculusXRPackageName)
);

OVRProjectSetup.AddTask(
    level: OVRConfigurationTask.TaskLevel.Recommended,
    group: OVRConfigurationTask.TaskGroup.Quality,
    isDone: buildTargetGroup => QualitySettings.pixelLightCount <= GetRecommendedPixelLightCount(buildTargetGroup),
    conditionalMessage: buildTargetGroup => $"Set maximum pixel lights count to {GetRecommendedPixelLightCount(buildTargetGroup)}",
    fix: buildTargetGroup => QualitySettings.pixelLightCount = GetRecommendedPixelLightCount(buildTargetGroup)
);

{
  "createdAt": "[Date]",
  "platform" : "[PlatformName]",
  "projectName": "[ProjectName]",
  "unityVersion": "[UnityVersion]",
  "projectUrl": "[ProjectPath]",
  "tasksStatus":
  [
    {
      "uid": "[Hash]",
      "group": "[TaskGroup]",
      "message": "[TaskMessage]",
      "level": "[TaskLevel]",
      "isDone": bool
    },
    {...}
  ]
}

• On Demand : Click on the menu icon within the Checklist, under the platform tab to generate a report for the selected platform. The .json report will be generated on the specified folder in the folder selection dialog box.
• On Build : Click the cog icon in the Unity Project Setup Tool window to toggle on/off the automatic generation of a report on build. The .json file will be generated on the same folder as the build.
• In Batchmode : Start the editor in batchmode and execute the following method :

  public static void GenerateProjectSetupReport()
  

> [UnityPath] -project [ProjectPath] -executeMethod OVRProjectSetupCLI.GenerateProjectSetupReport -reportFile [ReportFileName] buildTarget [PlatformName]