Last updated on
May 24, 2023
- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
sbsupdater command line options
sbsupdater
Usage
- sbsupdater [...]
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 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}"]
- 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.