Develop
Develop
Select your platform

Unreal Project Setup Tool

Updated: Sep 4, 2024
The Unreal Project Setup Tool is designed to help developers quickly configure projects using the Meta XR Plugin. This tool guides you through the necessary steps so you can start developing more quickly. The Unreal Project Setup Tool tests a registry of rules. We provide default rules to make your project ready.
Important: The Unreal Project Setup Tool requires Meta XR Plugin v62 or higher to function.

Checklist

From Meta XR Plugin v62 and higher
To access the tool, navigate to Edit > Project Settings > Meta XR > Launch Meta XR Project Setup Tool, or Meta XR Tools > Meta XR Project Setup Tool. Additionally, the status icon on the bottom right corner of the Editor will lead you directly to the tool.
This is the main panel on which all the rules are displayed, per target platform and per categories and/or levels. It provides a dashboard showing off any outstanding issues that have been detected on the project, as well as listing all those that have been validated or ignored.

Actions

The following actions are available for this tool:
  • Target Group Tabs: Switch between the different build target groups to see the list of rules that apply to each target group.
  • Fix All Button: After clicking this, this tool goes through all the outstanding rules in the section and fixes them all the best it can. Ideally, this makes any red project turns green!
Under the Settings menu in the upper right, the following actions are available:
  • Enable backgroud rule checks: Uncheck to stop checking rule status each frame.
  • Stop build on unapplied items: Uncheck to ignore failing rules when building/running.

Actions per rule

A rule is regularly checked for its validation status. The user can, however, interact directly with a rule in the following ways:
  • Apply: Manually call the fix action for this rule in order to resolve the issue. This action is only available for rules that are not already applied.
  • Ignore / Unignore: This moves the rule to another category that will get ignored for both checks and fixes.
Did you find this page helpful?