User Guide Cancel

Command lines | Substance 3D Painter

Command lines

This page list several command lines that can be used when launching the application to create or open projects for example.
These command lines can be used as follow:

"Adobe Substance 3D Painter.exe" --command [option]
"Adobe Substance 3D Painter.exe" --command [option]
"Adobe Substance 3D Painter.exe" --command [option] 

List of commands

Command

Description

--help
-?
-h

Display information about which command line are available and how to use them.

--version
-v

Display the current version of Substance 3D Painter.

--mesh

Mesh to load in a project.

Example:

// Create a new project with a specific mesh
"Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj"
// Update a mesh inside an existing project
"Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj" "E:/MyMeshFolder/Project.spp"
// Create a new project with a specific mesh "Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj" // Update a mesh inside an existing project "Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj" "E:/MyMeshFolder/Project.spp"
// Create a new project with a specific mesh 
"Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj"  
 
// Update a mesh inside an existing project 
"Adobe Substance 3D Painter.exe" --mesh "E:/MymeshFolder/MyMesh.obj" "E:/MyMeshFolder/Project.spp" 

--mesh-map

Baked maps associated with the mesh (AO, Normal, Curvature). Can be specified multiple times. Nomenclature : TextureSetName_AdditionalMapSlot

  • Ambient occlusion = ambient_occlusion
  • Curvature = curvature
  • Normal = normal_base
  • World Space Normal = world_space_normals
  • Position = position
  • Thickness = thickness
  • ID = id

Example:

"Adobe Substance 3D Painter.exe" --mesh "E:/MyMeshFolder/MyMesh.obj" --mesh-map " E:/MyMeshFolder/DefaultMaterial_ambient_occlusion.png"
"Adobe Substance 3D Painter.exe" --mesh "E:/MyMeshFolder/MyMesh.obj" --mesh-map " E:/MyMeshFolder/DefaultMaterial_ambient_occlusion.png"
"Adobe Substance 3D Painter.exe" --mesh "E:/MyMeshFolder/MyMesh.obj" --mesh-map " E:/MyMeshFolder/DefaultMaterial_ambient_occlusion.png" 

--split-by-udim

Create a texture set per UDIM tile.

--export-path

Default export path where the outputs of the project will be exported.

--vram-budget

Override the video memory (VRAM) budget defined by Substance 3D Painter engine. "Amount" is in megabytes.

Example:

// Set the VRam budget to 2GB
"Adobe Substance 3D Painter.exe" --vram-budget 2048
// Set the VRam budget to 2GB "Adobe Substance 3D Painter.exe" --vram-budget 2048
// Set the VRam budget to 2GB 
"Adobe Substance 3D Painter.exe" --vram-budget 2048 

--disable-version-checking

Don't check if a new version of the application is available when starting up

--enable-remote-scripting

Allow to run scripting commands from outside the application. See Remote control with scripting for more information.

Get help faster and easier

New user?