diegogarciahuerta/tk-substancepainter

:moyai: Shotgun Toolkit Engine for Allegorithmic Substance Painter https://www.allegorithmic.com/products/substance-painter

Hola! 👋

I’m Diego Garcia Huerta, a Software and Pipeline developer that works in the VFX / Animation industry. I’ve been designing workflows/pipelines and developing production tools for more than two decades, always trying to bridge the gap between artists and technology.

I work for small and mid size studios as a consultant, assessing and advising on how to optimize existing pipelines and production workflows and developing the required solutions. This allow studios to grow in size / quality / efficiency and enable artists to focus on what they know best.

I also specialize on starting pipelines from scratch, from nada, from zero, with already quite a few successful cases under my belt.

---

One of my tech hobbies involve the integration of new software with Shotgun Toolkit. I find it is a good way to familiarize myself with APIs from different DCCs. My goal is to integrate it with as many open source tools as possible. 💡 You can normally guess what I'm working on by checking my github status

Here are some of my integrations:

---

👀 Which one should be next ?

🚀 Do you want to boost the development ?

If you or your studio find that what I do is useful or it turns out to be a shortcut to what you really need to do, and you want to contribute, consider buying me a coffee:

❤️ Sponsor me

tk-substancepainter's Issues

Could not read templates configuration

Hi Diego,

I'm trying to test out your substance integration as my team are planning to move our project and asset management over to a shotgun/perforce pipeline very soon but I have been getting errors whenever I try to cache_apps:

ERROR: Could not read templates configuration: Could not open file
'D:\Shotgun\configs\jfo_test_project\config\core\templates.yml'. Error
reported: 'while scanning for the next token found character '\t' that cannot
start any token in
"D:\Shotgun\configs\jfo_test_project\config\core\templates.yml", line 60,
column 1'

Line 60 is where I have copied the keys code in from the templates file in the repo. If I remove that line I seem to just get the same error for the other lines I've added from the repo versions of the yml files.

Any chance you can help me out? I'm new to shotgun but will be one of our admins moving forward.

Cheers,
John

Does tk-substancepainter work for 2019

Hi,

Has anyone been able to succesfully run tk-substance with versions > 2019?
It seems to install fine, and I can load a new scene, but as soon as I save it, it bails.
So saver fires up, shows all right folders etc. But when I press save I get :

[Plugin - shotgun_bridge] Exception ProjectError: can't save, no project loaded (qrc:/js/project.js line 21)

Any ideas or pointers? Thanks!

error for shotgun python3

tk-substancepainter/startup.py

Line 278 in 233ed3a

args = ["%s=%s" % (k, v) for k, v in required_env.iteritems()]

Publish2 doesn't seem to look at publish settings for collector

I'm 90% sure that there is an issue with the publish2 implementation because it doesn't seem to look at the settings defined for the collector.

Whatever I do, I can't get it to look at the collector settings or the "Publish Textures as Folder" setting.

I've forked the engine and hardcoded the collector hook but it's a really weird one.

Connection was lost. Restarting engine...

The Integration isn't working for me. Im getting the log-message:
[Plugin - shotgun_bridge] Shotgun engine | Shotgun Substance Painter Engine connection was lost. Restarting engine...

I'm using:

• substancepainter engine v1.2.1
• framework-unrealqt v1.0.0
• Substance Painter 2020.1.2

I know the engine is only tested for 2019 but i wanted to make sure if the error i'm getting
occures because of my SP version or if I'm doing something wrong here.

EDIT: Oh in another issue it says that the engine is tested on 2020. :/

Sincerely
Jonas

Executable not found

The executable of Substance painter is not found on windows because in startup.py;

EXECUTABLE_TEMPLATES = {
    "darwin": ["/Applications/Allegorithmic/Substance Painter.app"],
    "win32": ["C:/Program Files/Allegorithmic/Substance Painter/Substance Painter.exe"],
    "linux2": [
        "/usr/Allegorithmic/Substance Painter",
        "/usr/Allegorithmic/Substance_Painter/Substance Painter",
        "/opt/Allegorithmic/Substance_Painter/Substance Painter",
    ],
}

The win32 path is not correct, it should be:
"win32": ["C:/Program Files/Adobe/Adobe Substance 3D Painter/Adobe Substance 3D Painter.exe"],

Texture export wait forever

Hi,
First thanks @diegogarciahuerta for the sharing of your Shotgun engines.

I'm using tk-substancepainter v1.2.2 with Substance Painter 2021.1.1 (7.1.1)
When doing a publish, the export process takes forever and nothing seems to append.
All I have is the engine busy dialog:

In the engine log, I just get a "Waiting for maps to be exported ..."
But on Substance Painter side, in the log view I have this:

[Plugin - shotgun_bridge] Shotgun engine | Engine is ready.
[Plugin - shotgun_bridge] Exception ProjectError: failed to retrieve project url (qrc:/js/project.js line 21)
[Plugin - shotgun_bridge] Empty format

Did I miss something when configuring my scene ?
Do I need to set the format somewhere in the Shotgun configuration or in Substance Painter ?
Could this be related to the Substance Painter version as the tk-substancepainter engine is reporting the version 7.1.1 as not being tested.

Shotgun menu icon not showing

Hi Diego,

I have been trying ton install your engine but it is not showing in substance and I am not recieving an error in the shotgun console... Do yoiu know how I might debug this?

Thanks!

Greetings
Sam

Has anyone tried to do a version of this engine using the Python API and not a separate server

2020 versioning changes

Substance painter went from version 2019.3.3 to version 6.1.0.
That breaks the minimum version check.

Loss of Wacom pressure sensitity when engine is running

Hey,
Getting a strange issue running tk-substancepainter on 2019.3.0 and up. Wacom sensitivity no longer works if we're running the engine. As soon as we launch SP without the engine we're fine. Was working fine with 2019.2.3.
I went and did a test by replacing the qml/JS side of the engine to use the new python api from SP and that doesn't cause any issues though of coarse their API isn't 100% so we can move to it yet. Wondering if you get the same issue on your end.
Based on SP change logs they moved to QT 5.12.5 for 2019.3.0.

The below image the left is without tk-substancepainter and all default SP settings, on the right is with the tk-substancepainter
running.

Any help is much appreciated.
Thanks,
Dave

Error: Unhashable Type

After merging all the ymls and trying to run the tank cache_apps command I get the following error:

ERROR: A general error was reported: unhashable type
Traceback (most recent call last):
File "C:\Volumes\project\6_ShotgunConfig\install\core\scripts\tank_cmd.py", line 1860, in
pipeline_config_root, ctx_list, cmd_name, using_cwd, cmd_args
File "C:\Volumes\project\6_ShotgunConfig\install\core\scripts\tank_cmd.py", line 1510, in run_engine_cmd
return run_action(logger, tk, ctx, command, args)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\commands\tank_command.py", line 563, in run_action
return found_action.run_interactive(log, args)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\commands\cache_apps.py", line 63, in run_interactive
return self._run(log)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\commands\cache_apps.py", line 81, in _run
env = self.tk.pipeline_configuration.get_environment(env_name)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\pipelineconfig.py", line 1149, in get_environment
env_obj = EnvClass(env_file, self, context)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment.py", line 762, in init
super(InstalledEnvironment, self).init(env_path, context)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment.py", line 63, in init
self._refresh()
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment.py", line 77, in _refresh
self._env_path, data, self.__context
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment_includes.py", line 186, in process_includes
data, _ = _process_includes_r(file_name, data, context)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment_includes.py", line 210, in _process_includes_r
include_files = _resolve_includes(file_name, data, context)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\platform\environment_includes.py", line 118, in _resolve_includes
path = resolve_include(file_name, include)
File "C:\Volumes\project\6_ShotgunConfig\install\core\python\tank\util\includes.py", line 72, in resolve_include
path = os.path.expanduser(os.path.expandvars(include))
File "C:\Program Files\Shotgun\Python\lib\ntpath.py", line 289, in expanduser
if path[:1] != '~':
TypeError: unhashable type

Do you know what the issue might be?

Compatibility with Python3

Hey - thanks for these integrations.
Is there a plan to update to support Py3 in the near future, most of the other integrations support Py3 but if I run desktop with Py3 enabled the integrations do not show-up anymore

Plugin directory for non-default documents folder

Hello,
I've been trying to run the plugin on my personal workstation which has most of the main folders moved to a secondary drive (i.e: D:\Documents\Allegorithmic).

Looking at the console output I can see that the files are being copied to the default documents folder instead of the actual one, rendering the plugin unusable as far as my understanding goes. I've tried to move the files manually to the correct path but I'm getting on the logs on Substance that the connection to toolkit has been lost, without any chances of getting it to work 😢

2019-05-19 20:09:19,559 [    INFO] [PROXY] running "&SGTK_SUBSTANCEPAINTER_ENGINE_STARTUP=C:/Users/alfon/AppData/Roaming/Shotgun/bundle_cache/git/tk-substancepainter/v1.1.0/startup/bootstrap.py&SGTK_SUBSTANCEPAINTER_ENGINE_PORT=60505&SGTK_SUBSTANCEPAINTER_SGTK_MODULE_PATH=C:\Users\alfon\AppData\Roaming\Shotgun\u-tad\p124c119.basic.desktop\cfg\install\core\python&SGTK_SUBSTANCEPAINTER_ENGINE_PYTHON=C:/Program Files/Shotgun/Python/python.exe"
2019-05-19 20:09:19,561 [    INFO] [PROXY] Updating scripts...: C:\Users\alfon\AppData\Roaming\Shotgun\bundle_cache\git\tk-substancepainter\v1.1.0\resources\plugins
2019-05-19 20:09:19,562 [    INFO] [PROXY]                      scripts_folder: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins
2019-05-19 20:09:19,562 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\CommandServer.qml
2019-05-19 20:09:19,562 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\icons\sg_hover.png
2019-05-19 20:09:19,563 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\icons\sg_idle.png
2019-05-19 20:09:19,565 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\LICENSE
2019-05-19 20:09:19,565 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\main.qml
2019-05-19 20:09:19,565 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\menu.qml
2019-05-19 20:09:19,566 [    INFO] [PROXY] Same file, skipping: C:\Users\alfon/Documents/Allegorithmic/Substance Painter/plugins\shotgun_bridge\plugin.json

Engine-locations.yml not updated

Hello,
The engine-locations.yml file is not updated on the newer version not loading the proper version of the plugins.
Also, on the readme documentation the code does not work, it should be like this:

# substancepainter
engines.tk-substancepainter.location:
  type: git
  path: https://github.com/diegogarciahuerta/tk-substancepainter
  version: v1.1.0

Cheers