Early draft for Substance Painter documentation

This commit is contained in:
Roy Nieterau 2023-01-17 17:01:59 +01:00
parent 9329ff28d5
commit 033d37ca28

View file

@ -0,0 +1,80 @@
---
id: artist_hosts_substancepainter
title: Substance Painter
sidebar_label: Substance Painter
---
## OpenPype global tools
- [Work Files](artist_tools.md#workfiles)
- [Load](artist_tools.md#loader)
- [Manage (Inventory)](artist_tools.md#inventory)
- [Publish](artist_tools.md#publisher)
- [Library Loader](artist_tools.md#library-loader)
## Working with OpenPype in Substance Painter
The Substance Painter OpenPype integration allows you to:
- Set the project mesh and easily keep it in sync with updates of the model
- Easily export your textures as versioned publishes for others to load and update.
## Setting the project mesh
Substance Painter requires a project file to have a mesh path configured.
As such, you can't start a workfile without choosing a mesh path.
To start a new project using a published model you can _without an open project_
use OpenPype > Load.. > Load Mesh on a supported publish. This will prompt you
with a New Project prompt preset to that particular mesh file.
If you already have a project open, you can also replace (reload) your mesh
using the same Load Mesh functionality.
After having the project mesh loaded or reloaded through the loader
tool the mesh will be _managed_ by OpenPype. For example, you'll be notified
on workfile open whether the mesh in your workfile is outdated. You can also
set it to specific version using OpenPype > Manage.. where you can right click
on the project mesh to perform _Set Version_
:::info
A Substance Painter project will always have only one mesh set. Whenever you
trigger _Load Mesh_ from the loader this will **replace** your currently loaded
mesh for your open project.
:::
## Publishing textures
To publish your textures we must first create a `textureSet`
publish instance.
To create a **TextureSet instance** we will use OpenPype's publisher tool. Go
to **OpenPype → Publish... → TextureSet**
The texture set instance will define what Substance Painter export template `.spexp` to
use and thus defines what texture maps will be exported from your workfile.
:::info
The TextureSet instance gets saved with your Substance Painter project. As such,
you will only need to configure this once for your workfile. Next time you can
just click **OpenPype → Publish...** and start publishing directly with the
same settings.
:::
### Known issues
#### Can't see the OpenPype menu?
If you're unable to see the OpenPype top level menu in Substance Painter make
sure you have launched Substance Painter through OpenPype and that the OpenPype
Integration plug-in is loaded inside Substance Painter: **Python > openpype_plugin**
#### Substance Painter + Steam
Running the steam version of Substance Painter within OpenPype will require you
to close the Steam executable before launching Substance Painter through OpenPype.
Otherwise the Substance Painter process is launched using Steam's existing
environment and thus will not be able to pick up the pipeline integration.
This appears to be a limitation of how Steam works.