Settings
Open Edit > Project Settings > Plugins > ta Blueprint Scribe, or click the settings (gear) button in the Blueprint Scribe panel.
The settings are stored in your project’s Config/DefaultEditor.ini, so the whole team shares them through source control. The panel, Data Validation, the TABlueprintScribe commandlet and the Python API all use the same settings. Audit settings take effect with the next scan.
| Setting | Default | Description |
|---|---|---|
| Included Paths | /Game |
Folders scanned by Scan project, by the commandlet when you don’t pass -Paths, by scan_project in Python and by Data Validation. |
| Excluded Paths | Empty | Folders that are never scanned. |
Paths are package paths such as /Game/Blueprints. A path includes all of its subfolders, and matching is case-insensitive.
Excluded Paths apply to every folder scan (Scan project, Scan selection with folders, Document and Audit Blueprints, the commandlet, also with -Paths, and scan_paths) and to Data Validation. Assets you select directly in the Content Browser are scanned even when they are in an excluded folder. World Partition one-file-per-actor folders (__ExternalActors__ and __ExternalObjects__) are always skipped.
Documentation
Section titled “Documentation”These settings are the export options. The panel’s Export page starts with them when the panel opens (reopen the panel tab to pick up changes), and the commandlet and get_default_export_options in Python use them.
| Setting | Default | Description |
|---|---|---|
| Title | Empty | Title on the documentation pages. When empty, the project name followed by “Blueprints”. |
| Output Directory | Saved/BlueprintScribe |
Where the documentation is written. Relative paths start at the project folder. See Output folder. |
| HTML | Enabled | A searchable website (index.html) that works offline. |
| Export Markdown | Enabled | One .md file per asset, for GitHub wikis, Obsidian and other Markdown tools. |
| JSON | Enabled | scribe.json with everything, for CI and your own tools. |
| AI-ready text | Enabled | Compact text for AI assistants (ai folder): graphs as readable logic, one .md per asset and a .jsonl. See AI export. |
| AI text lines per graph | 300 |
Longest AI text for one graph, in lines, from 20 to 5000. Longer graphs are cut and say so. Also applies to Copy for AI; takes effect with the next scan. |
| Graph Images | Enabled | PNG images of every graph, as they look in the Blueprint editor. Needs the editor UI (skipped in commandlets). |
| Graph Image Zoom | 1.0 |
Zoom of the graph images (1.0 = 100 %), from 0.25 to 2.0. Large graphs are zoomed out to fit the maximum image size. |
| Max Graph Image Size | 4096 |
Longest side of a graph image in pixels, from 512 to 16384. |
| Include Private Members | Enabled | Document private variables and functions too. |
| Include Audit in Docs | Enabled | Show the audit findings on the documentation pages. |
| Show Credit | Enabled | The “Generated with ta Blueprint Scribe” line at the bottom of the pages. See Credit line. |
| Open After Export | Enabled | Open the documentation in the browser after an export from the panel. |
Graph Image Zoom and Max Graph Image Size can only be edited while Graph Images is enabled. See Graph images.
| Setting | Default | Description |
|---|---|---|
| Run During Data Validation | Enabled | Run the audit as part of Data Validation (Validate Assets, validate on save, changelist validation). See Data Validation. |
| Min Validation Severity | Warning | Findings below this severity are not reported by Data Validation: Info, Warning or Error. |
Every rule can be turned off. The limits can only be edited while their rule is on. See Audit rules for what each rule checks.
| Setting | Default | Description |
|---|---|---|
| Compile errors and warnings | Enabled | Compile errors and warnings of Blueprints (Compile). |
| Large graphs | Enabled | Graphs and Blueprints with too many nodes (Graph.Large, Blueprint.Large). |
| Max Nodes Per Graph | 100 |
A graph (event graph, function, macro) with more nodes than this is reported. Comments and reroute nodes don’t count. Minimum 10. |
| Max Nodes Per Blueprint | 300 |
A Blueprint with more nodes than this in all of its graphs is reported. Minimum 10. |
| Event Tick | Enabled | Blueprints that implement Event Tick (Tick). |
| Tick Nodes Warning | 20 |
Event Tick running more nodes than this every frame is a warning instead of info. Minimum 1. |
| Hard reference weight | Enabled | Assets that load a lot of other content through hard references (References.Heavy). |
| Hard Reference Warning MB | 50 |
Hard references (recursive) larger than this on disk are reported, in MB. Minimum 1. |
| Casts to Blueprints | Enabled | Cast nodes that cast to Blueprint classes (Cast.Blueprint). |
| Circular references | Enabled | Hard reference cycles between Blueprints (References.Circular). |
| Unused variables | Enabled | Member variables that no graph reads or writes (Variable.Unused). |
| Dead and disabled nodes | Enabled | Nodes that never run, pure nodes whose results are not used, and disabled nodes (Nodes.Dead, Nodes.UnusedPure, Nodes.Disabled). |
| Deprecated nodes | Enabled | Deprecated nodes and functions (Nodes.Deprecated). |
| Missing descriptions | Enabled | Assets, functions, events and public variables without a description (Docs.Missing). |
Config file
Section titled “Config file”Settings you change in Project Settings are written to the [/Script/TABlueprintScribe.TABlueprintScribeSettings] section of Config/DefaultEditor.ini. Simple values look like this:
[/Script/TABlueprintScribe.TABlueprintScribeSettings]OutputDirectory=Docs/BlueprintsMaxGraphImageSize=8192MinValidationSeverity=InfoMaxNodesPerGraph=150TickNodesWarning=30bCheckMissingDocs=FalseThe keys in the file are the property names of the settings:
| Setting | Key |
|---|---|
| Included Paths, Excluded Paths | IncludedPaths, ExcludedPaths |
| Title, Output Directory | Title, OutputDirectory |
| HTML, Export Markdown, JSON, AI-ready text | bExportHtml, bExportMarkdown, bExportJson, bExportAiText |
| AI text lines per graph | AiLinesPerGraph |
| Graph Images, Graph Image Zoom, Max Graph Image Size | bGraphImages, GraphImageZoom, MaxGraphImageSize |
| Include Private Members, Include Audit in Docs, Show Credit, Open After Export | bIncludePrivateMembers, bIncludeAuditInDocs, bShowCredit, bOpenAfterExport |
| Run During Data Validation, Min Validation Severity | bRunDuringDataValidation, MinValidationSeverity |
| Compile errors and warnings | bCheckCompileStatus |
| Large graphs, Max Nodes Per Graph, Max Nodes Per Blueprint | bCheckLargeGraphs, MaxNodesPerGraph, MaxNodesPerBlueprint |
| Event Tick, Tick Nodes Warning | bCheckTick, TickNodesWarning |
| Hard reference weight, Hard Reference Warning MB | bCheckHardReferences, HardReferenceWarningMB |
| Casts to Blueprints | bCheckBlueprintCasts |
| Circular references | bCheckCircularReferences |
| Unused variables | bCheckUnusedVariables |
| Dead and disabled nodes | bCheckDeadNodes |
| Deprecated nodes | bCheckDeprecatedNodes |
| Missing descriptions | bCheckMissingDocs |
Edit the folder lists (Included Paths, Excluded Paths) in Project Settings rather than by hand.