Skip to content

Settings Reference

This page documents the settings currently exposed by ProStream in the active Settings Panel UI.

Opening the Settings Panel

Open via Tools > instance.id > ProStream > Settings > Panel, or from the settings icon in ProStream editor UI.

Settings Panel Tabs

The panel currently provides these primary tabs:

TabPanelDescription
GeneralGeneralPanelGeneral editor style and global object exclusion settings
Scene/SetupSceneSetupPanelScene setup and SubScene creation options
Search/MatchObjectMatchingPanelValidation and search query behavior
StreamingStreamingPanel(If DataObjects is enabled) Streaming job system configuration
WorkflowsWorkflowsPanelEnable/disable system-wide workflow assets
BuildBuildPanelBuild automation and cleanup settings
DebuggingDebuggingPanelScene View debugging and visualization settings

General Tab

Settings related to the overall ProStream editor and global tracking.

SettingDescription
User Excluded Type NamesComma-separated list of component type names. GameObjects with these components will be excluded from ProStream tracking, search operations, and quadtree processing.
Editor ThemeSelect the theme for the ProStream Editor.

Scene/Setup Tab

These settings dictate how SubScenes are generated.

SubScene Setup

SettingDefaultDescription
Filter Incompatible ShadersOffWhen creating SubScenes, whether to include GameObjects which have incompatible shaders. Objects with incompatible shaders are forced to the Shader Error color. Requires Check for advanced issues to be true.
Include Disabled ObjectsOffInclude disabled objects in the SubScene creation process. Disabled Objects are not converted to Entities, but simply exist in the SubScene.
Auto-Load SubScenes In EditorOffShould SubScene Entity visual representations automatically load in the editor after creation?

(Note: Additional settings from active Workflow Components may also inject themselves dynamically at the bottom of this tab).

Search/Match Tab

These settings affect rule matching and validation during Calculate Positions.

Matching Settings

SettingDefaultDescription
Check for basic issuesOnRuns common validation checks during matching (for example missing materials, collider mesh issues, invalid bounds/scale).
Check for advanced issuesOnRuns additional shader compatibility checks (SRP-dependent). More expensive but useful for conversion/runtime safety.

Search Keyword

SettingDefaultDescription
Use keyword separationOffAdds separator characters around search terms to reduce false positives from fuzzy matching.
Keyword separatorNoneThe character used to separate keywords when keyword separation is enabled.

Example:

Without keyword separation:

  • Search for Tree matches: Environment_Tree_01 and City_Street_01 (false positive)

With keyword separation (separator = _):

  • Search for Tree becomes _Tree_
  • Matches: Environment_Tree_01 but NOT City_Street_01

INFO

You can achieve similar results by manually including separator characters in your search query (e.g., searching for _Tree_ instead of Tree), but enabling this setting automatically adds separators to all search terms for convenience.

Streaming Tab

This tab is only active if DataObjects are being used in the project.

SettingDescription
Section Batch LimiterUse section batch limiter to limit the number of sections processed per frame when loading SubScenes.
Job Batch CountThe inner loop value for prefab instantiation.
Section IterationsHow many sections should be processed per frame when loading SubScenes.

Workflows Tab

This tab lists all discovered WorkflowAssets in the project (e.g., InstanceObjectsWorkflow, ColliderObjectsWorkflow). You can toggle whether a workflow is Active across the project.

Note: Deactivating a workflow fully disables all associated functionality.

Build Tab

Settings relating to the final Unity Build process.

SettingDescription
Auto Add GameObject Scenes To BuildAutomatically add any GameObject SubScenes to the build settings when creating SubScenes.
Auto Remove GameObject Scenes From BuildAutomatically remove generated GameObject SubScenes from the build settings when resetting the scene.
Remove Original Objects In BuildRemove the original source GameObjects which were converted to Entities from the final scene when building. (This is safe, it does not affect your editor scene, only build)

Debugging Tab

Settings to draw useful visual debug bounds in the Unity Scene View.

SettingDescription
Loading DistanceEnable SubScene loading distance debugging.
Layer NumberLayer in which to show debug info.
Debug Label HeightHeight of debug labels.
SubScene LabelsShould SubScene Labels be displayed.
Position LabelsShould Position Labels be displayed.
SubScene BoundsShould SubScene Bounds be displayed.
Layer/Section BoundsShould Layer/Section Bounds be displayed.
SubScene DistancesShould SubScene distance lines be displayed.
SubScene Load ThresholdShould SubScene load threshold be displayed.

TIP

See Validation & Diagnostics for detailed information on what each validation level checks.

Layer Configuration

Layer-specific settings are configured in the Layer Editor, not the Settings Panel.

Access: SceneConnector Inspector → Layer Editor button

Per-Layer Settings:

  • Load distance (meters)
  • Persistent (always loaded)
  • Enabled/disabled
  • Section index

See Streaming Layers for details.

Rule Configuration

Rule-specific settings are configured in the Rule Editor.

Access: ProStream Editor → Scene Match RulesRule Editor

Per-Rule Settings:

  • Enabled/disabled
  • Priority (execution order)
  • Target layer
  • Rule-specific parameters

See Rule Engine for details.

Modification Configuration

Modification-specific settings are configured on individual modification assets.

Access: Select modification asset in Project window

Per-Modification Settings:

  • Enabled/disabled
  • Execution placement
  • Execution order
  • Modification-specific parameters

See Modification Engine for details.

Settings Storage

ProStream settings are stored in:

  • Global package settings: Packages/id.instance.prostream/AssetFiles/Settings/ProStreamSettings.asset
  • Scene settings: SceneName/PSSceneData/SceneName_Settings.asset

In practice, most user workflow settings you edit per scene are stored in the scene settings asset.

See Also

ProStream - High-performance scene streaming for Unity