Docs

# Basic run — scans all of /Game/
.\Scripts\run_commandlet.ps1 -Policy "fab/v0"

# Scoped to a pack
.\Scripts\run_commandlet.ps1 -Policy "fab/v0" -PackName "MyGame"

# With auto-fix and evidence
.\Scripts\run_commandlet.ps1 -Policy "fab/v0" -AutoFix -ZipEvidence

# Basic run
./Scripts/run_commandlet.sh --policy "fab/v0"

# Scoped to a pack
./Scripts/run_commandlet.sh --policy "fab/v0" --pack-name "MyGame"

UnrealEditor-Cmd.exe MyProject.uproject \
  -run=FabReady \
  -OutputDir="Output" \
  -Policy=fab/v0 \
  -AutoFix=1 \
  -ZipEvidence=1 \
  -BuildStagingZip=1 \
  -unattended -nopause

Policies/
└── fab/v0/
    ├── policy.json         # Main policy definition
    └── rules/
        ├── 000_pack_structure.json
        ├── 001_redirectors.json
        ├── 010_naming.json
        └── ...

{
  "policy_id": "fab/v0",
  "version": "0.1.0",
  "name": "FabReady Base Policy Pack",
  "description": "Core shipping QA rules for Fab submissions",
  "rules": [
    {
      "rule_id": "fab.structure.pack_structure",
      "path": "rules/000_pack_structure.json",
      "enabled": true,
      "severity": "error"
    }
  ]
}

{
  "rule_id": "fab.textures.validation",
  "title": "Texture Dimension Validation",
  "description": "Validates power-of-2 and max resolution",
  "severity_default": "warning",
  "params_schema": {
    "type": "object",
    "properties": {
      "max_resolution": {
        "type": "integer",
        "default": 4096
      }
    }
  },
  "implementation": "builtin"
}

{
  "policy_id": "custom/strict",
  "version": "1.0.0",
  "name": "Strict Shipping Rules",
  "description": "All warnings promoted to errors",
  "rules": [
    {
      "rule_id": "fab.assets.redirectors",
      "path": "../../fab/v0/rules/001_redirectors.json",
      "enabled": true,
      "severity": "error"
    }
  ]
}

{
  "schema_version": "fabready.report.v0",
  "policy_pack_version": "0.1.0",
  "run_fingerprint": "a3f8c1d2e4b67890...",
  "context": {
    "project_path": "/path/to/project",
    "pack_name": "MyGame",
    "policy_id": "fab/v0",
    "engine_version": "5.7.0-...",
    "timestamp_utc": "2026-03-20T22:23:00Z",
    "auto_fix_enabled": false
  },
  "summary": {
    "total": 30, "errors": 3,
    "warnings": 27, "info": 0
  },
  "findings": [
    {
      "rule_id": "fab.textures.validation",
      "severity": "error",
      "message": "Texture exceeds maximum resolution",
      "asset_or_path": "/Game/T_Oversized",
      "remediation": "Resize to 4096 or smaller",
      "can_auto_fix": false
    }
  ]
}

#include "FabReadyRuleInterface.h"

class FMyCustomRule : public IFabReadyRule
{
public:
    virtual FString GetRuleId() const override
    {
        return TEXT("custom.my_rule");
    }

    virtual void Evaluate(
        const FFabReadyRunContext& Context,
        const FFabReadyRuleDefinition& RuleDef,
        TArray<FFabReadyFinding>& OutFindings) override
    {
        // Your validation logic here
        FFabReadyFinding Finding;
        Finding.RuleId = GetRuleId();
        Finding.Severity = RuleDef.SeverityDefault;
        Finding.Message = TEXT("Something to report");
        OutFindings.Add(Finding);
    }
};

FABREADY_REGISTER_RULE(FMyCustomRule)

class FMyAugmenter : public IFabReadyReportAugmenter
{
    virtual FString GetAugmenterId() const override
    {
        return TEXT("my-augmenter");
    }

    virtual void AugmentReport(
        FFabReadyReport& Report) override
    {
        // Add fields to the report extensions
    }

    virtual TArray<FString> GetAdditionalArtifactPaths(
        const FFabReadyRunContext& Context) const override
    {
        return { TEXT("my_data.json") };
    }
};