analyze-sbs

Analyze SBS File

Analyze the structure and contents of a Substance Designer .sbs file.

Task

1. If $ARGUMENTS contains a file path, analyze that specific .sbs file
2. If no path provided, search for .sbs files in the current project
3. For each .sbs file, extract and report:
   • File metadata (version, UID)
   • List of graphs with their identifiers
   • For each graph:
     • Input parameters (type, widget, default value)
     • Input images
     • Output nodes with usages
     • Node count by type (filters, instances, etc.)
   • Functions defined
   • Resources (bitmaps, SVGs, fonts)
   • Dependencies on other packages

Analysis Code Pattern

from pysbs import context, substance

def analyze_sbs(sbs_path):
    ctx = context.Context()
    doc = substance.SBSDocument(ctx, sbs_path)
    doc.parseDoc()

    info = {
        'path': sbs_path,
        'format_version': doc.mFormatVersion,
        'file_uid': doc.mFileUID,
        'graphs': [],
        'functions': [],
        'resources': [],
        'dependencies': []
    }

    # Analyze graphs
    for graph in doc.getSBSGraphList():
        graph_info = {
            'identifier': graph.mIdentifier,
            'uid': graph.mUID,
            'input_params': [],
            'input_images': [],
            'outputs': [],
            'node_count': len(graph.getNodeList()),
            'filter_count': len([n for n in graph.getNodeList() if n.isAFilter()]),
            'instance_count': len([n for n in graph.getNodeList() if n.isAnInstance()])
        }

        for param in graph.getInputParameters():
            graph_info['input_params'].append({
                'identifier': param.mIdentifier,
                'type': str(param.getType()),
                'widget': str(param.getWidget())
            })

        for img in graph.getInputImages():
            graph_info['input_images'].append(img.mIdentifier)

        for output in graph.getGraphOutputs():
            graph_info['outputs'].append({
                'identifier': output.mIdentifier,
                'usages': [str(u) for u in output.getUsages()]
            })

        info['graphs'].append(graph_info)

    # Functions
    for func in doc.getSBSFunctionList():
        info['functions'].append(func.mIdentifier)

    # Resources
    for res in doc.getSBSResourceList():
        info['resources'].append({
            'identifier': res.mIdentifier,
            'type': str(res.getResourceType())
        })

    # Dependencies
    for dep in doc.getSBSDependencyList():
        info['dependencies'].append(dep.mFilename)

    return info

Output Format

Present the analysis in a clear, hierarchical format showing the complete structure of the .sbs file.