SAT PySBS Logo
  • Getting started with the API
  • API overview
  • API Content
  • Command Line Tools
    • substance3d_baker — Bakes out mesh specific data such as ambient occlusion or normal data to textures.
    • sbscooker — Cooks .sbs files to .sbsar files ready to be rendered with sbsrender.
    • sbsmutator — Modifies and specializes .sbs files.
    • sbsrender — Renders out maps from .sbsar files.
    • sbsupdater — Updates .sbs files to the current version of the batch tools.
  • Changelog
SAT PySBS
  • Command Line Tools

Command Line Tools

The Substance Automation Toolkit contains a set of command lines tools allowing you to automate many stages of the Substance Designer workflows. A complete workflow typically involves multiple tools being invoked in chain to accomplish the task.

The available commands are:

  • substance3d_baker — Bakes out mesh specific data such as ambient occlusion or normal data to textures.
    • substance3d_baker command line options
    • substance3d_baker Example Command Lines
      • Bake 1024x1024 normal map for a mesh
      • Bake 512x512 material color map from a high resolution map to the texture space of a low resolution mesh
      • Bake 512x512 material color map from a low resolution mesh
      • Bake 512x512 curvature map and control the name and the image file type
      • substance3d_baker run, use a Designer baker preset file as input
  • sbscooker — Cooks .sbs files to .sbsar files ready to be rendered with sbsrender.
    • sbscooker command line options
    • sbscooker pattern variables
  • sbsmutator — Modifies and specializes .sbs files.
    • sbsmutator command line options
    • sbsmutator Example Command Lines
      • Modify an SBS file to connect bitmap to input nodes of a graph
  • sbsrender — Renders out maps from .sbsar files.
    • sbsrender command line options
    • sbsrender example command lines
      • OpenColorIO with sbsrender
    • sbsrender base parameters and pattern variables
      • Base parameters
      • Pattern variables
  • sbsupdater — Updates .sbs files to the current version of the batch tools.
    • sbsupdater command line options
Previous Next

© Copyright 2021, Adobe.

Built with Sphinx using a theme provided by Read the Docs.