YAML: generalclassGeneralConfig

General

Controls project scanning and asset root path mapping. All root_key:// protocol paths resolve through this block.

sourcefastsim/configs/general_cfg.py

Top-level Fields2

FieldTypeRequiredDefaultDescription / Constraints
scan_projectbooloptionalfalseScan user project on startup to auto-register custom stereotypes defined via @stereotype (executed by ProjectLoader.scan_project)
root_pathsdict[str, str]optional{}Asset root path mapping; keys become root_key:// protocol prefixes, values are local absolute directory paths
Each path must be an existing local directory; validate_root_paths() raises on startup if a path is missing

Example

general blockYAML
general:
  scan_project: true
  root_paths:
    assets: /home/user/robot_assets
    datasets: /home/user/datasets

# 使用效果 / Usage:
# assets://robots/ur5.usd  → /home/user/robot_assets/robots/ur5.usd
# datasets://runs/run001   → /home/user/datasets/runs/run001