Setup local asset validation

The setup is recommended to be done by one person in your team and version controlled to avoid unnecessary duplication of work.

Linting

  1. Enable the โ€œLinterโ€ plugin by adding the following to your .uproject file. { "Name": "Linter", "Enabled": true, }

  2. Version control this so all devs can use it without doing this step

  3. Run a first-pass validation

    1. Right-click your plugin folder and select โ€œScan with Linterโ€

    2. Select the WorldBuilder Preflight RuleSet and click โ€œNextโ€

  4. Once you have your first validation result and opened, there will likely be many errors under โ€œ2.11 Asset references across pluginsโ€œ. To fix this, in your World Builder .uplugin that stores your content and that youโ€™ll upload, you need to add the content dependencies that you use.

    1. Using your validation result, collate a list of plugins you need to add dependencies for. In the below example, Iโ€™ll add M2Core, M2Content, JunoSkypark (e.g. if the error says โ€œThis asset references "/M2Core/โ€ฆโ€` then you need the M2Core dependency)

    2. Navigate to the .uplugin file, open it in your favourite text editor which should look like this

    3. Add the following section, and add each plugin dependency you need.

      	"Plugins":
        	[
      		{
      			"Name": "M2Content",
      			"Enabled": true
      		},
      		{
      			"Name": "M2Core",
      			"Enabled": true
      		},
      		{
      			"Name": "JunoSkypark",
      			"Enabled": true
      		}
        	]
  5. The .uplugin file should now look like this. Make sure to also version control this modified file.

  6. Re-run the linter, which should now be free of those errors and will be left with relevant validation issues.

  7. (optional) Copy the M2upPreflightRuleSet you just used and make a local version so you can control your own validation settings.

Cooking

You can run a normal World Builder package to test your content cooks correctly, while also avoiding uploading the content which can take a long time and is unnecessary for pure validation.

  1. Navigate to your World Builder settings and enable โ€œShow Package Only Commandโ€

You can version control this change by using โ€œSet as Defaultโ€ in the top-right of the Editor Preferences, which will update DefaultPerProjectUserSettings.ini in your project config folder.

Last updated