User Guide Cancel

sbsmutator command line options | Substance 3D Automation ToolKit

  1. Substance 3D home
  2. Home
  3. Command Line Tools
    1. Command Line overview
    2. sbsbaker
      1. sbsbaker overview
      2. sbsbaker command line options
      3. sbsbaker Example Command Lines
    3. sbscooker
      1. sbscooker overview
      2. sbscooker command line options
      3. sbscooker pattern variables
    4. sbsmtools
      1. sbsmtools overview
      2. sbsmtools command line options
    5. sbsmutator
      1. sbsmutator overview
      2. sbsmutator command line options
      3. sbsmutator Example Command Lines
    6. sbsrender
      1. sbsrender overview
      2. sbsrender base parameters and pattern variables
      3. sbsrender command line options
      4. sbsrender example command lines
    7. sbsupdater
      1. sbsupdater overview
      2. sbsupdater command line options
  4. Pysbs - Python API
    1. Pysbs - Python API overview
    2. Getting started
    3. General topics
      1. Basic manipulation
      2. Substance creation
      3. Substances modification
      4. Dependencies management
      5. PySbs batchtools module
      6. metadata manipulation
      7. SAT demos
      8. Edit sbsar with SBSARManager
      9. Spot Colors
      10. Thumbnail creation with SAT
    4. Examples
      1. demohelloworld
      2. demos
      3. demos_batchtools
      4. script_update_with_sbsupdater
    5. API Content
      1. API Content overview
      2. Substance definitions
        1. Common interfaces
          1. basegraph
          2. package
          3. sbsarobject
          4. sbsobject
        2. compnode
          1. compnode overview
          2. common
          3. compimplementation
          4. paramgraph
        3. context projectmgr
        4. graph
          1. graph overview
          2. function
          3. inputparameters
          4. output
        5. mdl
          1. mdlannotation
          2. mdlcommon
          3. mdldictionaries
          4. mdlenum
          5. mdlgraph
          6. mdllibclasses
          7. mdlmanager
          8. mdlnode
          9. mdlnodeimpl
          10. mdloperand
          11. mdlsbsbridge
        6. modelgraphindex
          1. modelannotationnames
          2. modelgraph
          3. modelgraphgenerator
          4. modelgraphimplementation
          5. modelnodenames
          6. modeloperand
          7. modulegraphindex
          8. moduleannotation
          9. moduleconnection
          10. modulegraph
          11. modulegraphgenerator
          12. modulegraphimplementation
          13. modulegraphlibrary
          14. modulegraphregister
          15. modulenode
          16. modulenodeimplementation
          17. modulenodeinstance
          18. moduleoperand
          19. moduleoutputbridging
          20. moduleparaminput
        7. params
          1. params overview
          2. dynamicvalue
          3. paramnode
        8. projectmgrdoc
        9. sbsarchive
          1. sbsarchive overview
          2. sbsarenum
          3. sbsargraph
          4. sbsargui
          5. sbsarguiwidgets
          6. sbsarmanager
        10. sbscommon
          1. connections
          2. gui
          3. nodes
          4. values
        11. sbspreset
        12. sbsproject
        13. substance
          1. substance overview
          2. content
          3. resource
      3. Libraries
        1. sbsenum
        2. sbslibrary
          1. sbslibrary overview
          2. sbsdictionaries
          3. sbsfilters
          4. sbsfunctions
          5. sbsfxmapnodes
          6. sbslibclasses
          7. sbswidgets
        3. sbsbakerslibrary
          1. sbsbakerslibrary overview
          2. sbsbakersdef
          3. sbsbakersdefaultprops
          4. sbsbakersdictionaries
          5. sbsbakersenum
          6. sbsbakingconverter
          7. sbsbakingconverterparam
          8. sbsbakingparameters
          9. sbsdialogstate
          10. sbsscenedata
        4. Helpers
          1. sbscleaner
          2. sbsexporter
          3. sbsgenerator
          4. sbsparser
          5. sbswriter
          6. qtclasses
            1. qtclasses overview
            2. qtvariantreader
            3. qtvariantwriter
          7. psdparser
          8. sbsimpactmanager
          9. batchtools
          10. autograph
            1. ag_functions
            2. ag_layout
            3. ag_types
          11. info_mesh_parser
          12. sbsbaker_info_handlers
          13. sbsrender_render_handlers
          14. output_handlers
          15. spotcolorinfo_handler
          16. thumbnail
          17. batchtools overview
        5. Execution context
          1. context
          2. functions
        6. API Change log
  5. Samples
    1. Samples overview
    2. Texturing Template Demo
    3. Batch Tools Demo
    4. Variations
    5. Texture Mat
    6. Pixel Processor Ray tracer
  6. Setup and Getting Started
    1. Setup and Getting Started overview
    2. Compatibility
    3. Frequently asked Questions
    4. Known issues
    5. SAT Cookbook
    6. Use Pysbs in different python interpreter (maya, sd, blender...)
  7. Integrations
    1. Substance Maya toolset
      1. Substance Maya Toolset overview
      2. Installing
      3. Launching
      4. Baking
        1. Baking overview
        2. Export parameters
        3. Baker parameters
        4. Mesh setup
        5. Using a template
      5. Changelog
  8. Changelog overview

sbsmutator command line options

sbsmutator

Usage

  • sbsmutator [...] edit [...]
  • sbsmutator [...] export [...]
  • sbsmutator [...] graph-parameters-editor [...]
  • sbsmutator [...] info [...]
  • sbsmutator [...] instantiate [...]
  • sbsmutator [...] specialization [...]
  • sbsmutator [...] update [...]

Global options

--doc-html, --doc
Generate basic documentation html from the option's help.
--help, -h, -?
Display help about given subcommand. If no subcommand is provided, this help about global options is printed.
--opt-descr
Create json description of all available options
--quiet, -q
Disable warning messages.
--verbose, -v
Enable info and debug messages.
--version, -V
Display version of the program.

Subcommand edit

Description

Edit or instantiate the inputs, outputs or parameters of a graph in a substance file.

Input file options

--alias
Define a custom alias path (e.g. 'myproject:⁄⁄path⁄to⁄myproject⁄library'). This option is mandatory if your filter have a dependency with some custom alias.
--inputs, --input
Specify a substance file to mutate with sbsmutator. Can be given multiple times
--no-dependency
Disable loading of dependencies.
--presets-path
Path to presets library (shorthand for '--alias sbs:⁄⁄'). This option is mandatory if your filter have a dependency to the presets library.

Output file options

--output-merge
Merge generated content with output if a file is present, otherwise the file is overwritten.
--output-name [default: "{inputName}_edited"]
Set the output name of the generated files, without the extension. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputName} : replaced by the input filename.
--output-path
Set the output path for the generated files. By default the path is empty, i.e. the files will be saved in the current directory. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputPath} : replaced by the input filepath.

Options for graph input⁄output

--input-graph
Select a specific graph from the loaded files. If you are editing multiple files, this options will apply to them all. If no graph are selected, the first graph found will be used.
--output-graph-author
Set the author name of the graph in the output substance file.
--output-graph-author-url
Set the author's URL of the graph in the output substance file.
--output-graph-category
Set the category of the graph in the output substance file.
--output-graph-description
Set the description text of the graph in the output substance file.
--output-graph-icon
Set the icon of the graph in the output substance file.
--output-graph-label
Set the label of the graph in the output substance file.
--output-graph-name [default: "{inputGraph}"]
Name of the edited or generated graph to give in the output substance file. Default='{inputGraph}'. You can use the following patterns that will be replaced by the program when saving the result of the process: -{inputGraph} replaced by the input graph name.
--output-graph-physical-size ,,
Set the physical size of the graph in the output substance file, in cm. Vector components must be separated by comma. Example: --output-graph-physical-size 10.5,10.5,8
--output-graph-tags
Set the tags of the graph in the output substance file.
--output-graph-user-data
Set user data of the graph in the output substance file.

Specific options

--connect-image
Import image as resource in the new file, create a bitmap node and connect it to filter's input named. format of : [@@]... Available key-value parameters are: - "path" path of the image file - "format" cooked format of image (RAW⁄JPEG) - "level" cooking compression level of image (0 to 1) - "tiling" tiling of image activation (0 or 1) - "absolute-size" adapt image resolution relative to the parent or keep the absolute image size (0 or 1). - "bit-depth" set the bit depth of the created image node.Can be set to "auto", "8", "16", "16f", "32f". You must provide the "path" parameter, so must look at least like @path@
--connect-input
Create an input node and connect it to the input of the same identifier in the created instance filter. Only valid together with option --instantiate.
--hide-parameter
Specifically hide parameter with identifier of the filter. Only valid together with option --instantiate.
--hide-parameters
Hide all specific parameters of the filter. Implies --remove-all-presets. Only valid together with option --instantiate.
--insert-sbsprs
Inject the presets contained in a *.sbsprs file into the output sbs.
--instantiate
Switch to instantiation mode. In instantiation mode, the graph is not edited in-place; rather another graph is created with a instance node pointing to the input graph. Some operations can only work when using this option. Warning: The input of the instance are not exposed to the new graph by default.You need to use option --connect-input to expose them.
--remove-all-presets
Remove all presets from the output graph.
--remove-output
Remove the output node connected to filter's output those identifier is .
--remove-preset
Remove a preset from from an sbs file. is the name of the preset to remove.
--set-bit-depth
Change the bit depth of the graph. can be set to "8" (or "int8"), "16" (or "int16"), "16f" (or "float16") or "32f" (or "float32").
--set-default-value
Set default value of input. Format of : @ Please note that the value is clamped between min and max.
--switch-to-constant
Remove input and switch all places using this input to a constant value. format of '': or @

Subcommand export

Description

Export substance files with their dependencies.

Input file options

--alias
Define a custom alias path (e.g. 'myproject:⁄⁄path⁄to⁄myproject⁄library'). This option is mandatory if your filter have a dependency with some custom alias.
--inputs, --input
Specify a substance file to mutate with sbsmutator. Can be given multiple times
--no-dependency
Disable loading of dependencies.
--presets-path
Path to presets library (shorthand for '--alias sbs:⁄⁄'). This option is mandatory if your filter have a dependency to the presets library.

Output file options

--output-path
Set the output path for the generated files. By default the path is empty, i.e. the files will be saved in the current directory. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputPath} : replaced by the input filepath.

Specific options

--build-archive
Compress the result in a 7z archive.
--preserve-alias
Do not automatically convert alias with name into this computer's corresponding absolute path.

Subcommand graph-parameters-editor

Description

Alias to `edit`

Subcommand info

Description

Return description of a substance file.

Input file options

--inputs, --input
Specify a substance file to mutate with sbsmutator. Can be given multiple times

Specific options

--hide-details
Hide additional details about the inputs and outputs of the graph.
--print-attributes
Print the attributes of the graph.
--print-input-parameters
Print the non-image input parameters of the graph.
--print-inputs
Print the image inputs of the graph.
--print-outputs
Print the image outputs of the graph.
--print-presets
Print the presets of the graph.

Subcommand instantiate

Description

Alias to `edit --instantiate`

Subcommand specialization

Description

Alias to `edit --instantiate`. Default output name is "{inputName}_specialized".

Subcommand update

Description

Update substance files to the lastest format.

Input file options

--alias
Define a custom alias path (e.g. 'myproject:⁄⁄path⁄to⁄myproject⁄library'). This option is mandatory if your filter have a dependency with some custom alias.
--inputs, --input
Specify a substance file to mutate with sbsmutator. Can be given multiple times
--no-dependency
Disable loading of dependencies.
--presets-path
Path to presets library (shorthand for '--alias sbs:⁄⁄'). This option is mandatory if your filter have a dependency to the presets library.
--recursive, -r
recurse into directories to find input files

Output file options

--output-name [default: "{inputName}_updated"]
Set the output name of the generated files, without the extension. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputName} : replaced by the input filename.
--output-path
Set the output path for the generated files. By default the path is empty, i.e. the files will be saved in the current directory. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputPath} : replaced by the input filepath.

 Adobe

Get help faster and easier

New user?